net.sf.jasperreports.charts.type.TimePeriodEnum Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasperreports-javaflow Show documentation
Free Java Reporting Library
The newest version!
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JasperReports. If not, see .
 */
package net.sf.jasperreports.charts.type;

import net.sf.jasperreports.charts.util.ChartUtil;
import net.sf.jasperreports.engine.type.EnumUtil;
import net.sf.jasperreports.engine.type.NamedEnum;


/**
 * @author Teodor Danciu ([email protected])
 */
public enum TimePeriodEnum implements NamedEnum
{
	/**
	 *
	 */
	YEAR("Year"),

	/**
	 *
	 */
	QUARTER("Quarter"),
	
	/**
	 *
	 */
	MONTH("Month"),
	
	/**
	 *
	 */
	WEEK("Week"),
	
	/**
	 *
	 */
	DAY("Day"),
	
	/**
	 *
	 */
	HOUR("Hour"),
	
	/**
	 *
	 */
	MINUTE("Minute"),
	
	/**
	 *
	 */
	SECOND("Second"),
	
	/**
	 *
	 */
	MILLISECOND("Millisecond");


	/**
	 *
	 */
	private final transient String name;

	private TimePeriodEnum(String name)
	{
		this.name = name;
	}

	@Override
	public String getName()
	{
		return name;
	}
	
 	/**
	 * @deprecated Replaced by {@link ChartUtil#getTimePeriod(TimePeriodEnum)}.
	 */
	public final Class getTimePeriod()
	{
		return ChartUtil.getTimePeriod(this);
	}

	/**
	 *
	 */
	public static TimePeriodEnum getByName(String name)
	{
		if ("Milisecond".equals(name)) // deal with historical spelling error
		{
			return MILLISECOND;
		}
		return EnumUtil.getEnumByName(values(), name);
	}
	
	
	/**
	 *
	 */
	public static TimePeriodEnum getByValue(Class clazz)
	{
		return ChartUtil.getTimePeriod(clazz);
	}

}