com.arcusx.chrono.Year Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arcusx-chrono Show documentation
${project.artifactId}
The newest version!
/**
 * This software is written by arcus(x) GmbH and subject 
 * to a contract between arcus(x) and its customer.
 *
 * This software stays property of arcus(x) unless differing
 * arrangements between arcus(x) and its customer apply.
 *
 * arcus(x) GmbH
 * Bergiusstrasse 27
 * D-22765 Hamburg, Germany
 * 
 * Tel.: +49 (0)40.333 102 92  
 * http://www.arcusx.com
 * mailto:[email protected]
 */

package com.arcusx.chrono;

import java.io.Serializable;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;

/**
 * A date with year part only.
 * 
 * Created 02.10.2003, 16:34:42.
 * 
 * @author conni
 * @version $Id$
 */
public final class Year implements Serializable, Comparable
{
	private static final long serialVersionUID = 1L;

	private int year;

	public static Year current()
	{
		GregorianCalendar cal = new GregorianCalendar();

		return Year.valueOf(cal);
	}

	public static Year valueOf(String s)
	{
		if (s.startsWith("Year{") && s.endsWith("}"))
			s = s.substring("Year{".length(), s.length() - 1);

		return new Year(Integer.parseInt(s));
	}

	public static Year valueOf(Date date)
	{
		GregorianCalendar cal = new GregorianCalendar();
		cal.setTime(date);

		return Year.valueOf(cal);
	}

	public static Year valueOf(Calendar cal)
	{
		return new Year(cal.get(Calendar.YEAR));
	}

	public static Year latestOf(Year... years)
	{
		return latestOf(years, false);
	}

	public static Year latestOf(Year[] years, boolean nullAllowed)
	{
		Year max = null;
		for (Year year : years)
		{
			if (!nullAllowed && year == null)
				throw new IllegalArgumentException("Year may not be null.");

			if (max == null || (year != null && year.after(max)))
				max = year;
		}
		return max;
	}

	public Year(int year)
	{
		this.year = year;
	}

	public Month getFirstMonth()
	{
		return new Month(this.year, Month.JANUARY);
	}

	public Month getLastMonth()
	{
		return new Month(this.year, Month.DECEMBER);
	}

	public int getYearValue()
	{
		return this.year;
	}

	public int hashCode()
	{
		return this.year;
	}

	public int compareTo(Object other)
	{
		if (!(other instanceof Year))
			throw new IllegalArgumentException("Year cannot be compared to " + other);

		return this.year - ((Year) other).year;
	}

	public boolean equals(Object other)
	{
		if (other == null)
			return false;

		if (!Year.class.equals(other.getClass()))
			return false;

		Year otherYear = (Year) other;

		return otherYear.year == this.year;
	}

	public boolean before(Year other)
	{
		return this.year < other.year;
	}

	public boolean beforeOrEqual(Year other)
	{
		return this.year <= other.year;
	}

	public boolean after(Year other)
	{
		return this.year > other.year;
	}

	public boolean afterOrEqual(Year other)
	{
		return this.year >= other.year;
	}

	public MonthSequence toMonths()
	{
		return new MonthSequence(getFirstMonth(), getLastMonth());
	}

	public Year add(int years)
	{
		return new Year(this.year + years);
	}

	public Year subtract(int years)
	{
		return add(-years);
	}

	public String toString()
	{
		return "Year{" + this.year + "}";
	}

	public boolean isLeapYear(int year)
	{

		// Test for leapyear
		if (((year % 400) == 0) || ((year % 4) == 0) && ((year % 100) != 0))
		{
			return true;
		}

		return false;
	}

	public int amountOfLeapYears(int firstYear, int lastYear)
	{

		int count = 0;

		for (int year = firstYear; year < lastYear; year++)
		{
			if (isLeapYear(year))
				count++;
		}

		return count;
	}

	public Long toLong()
	{
		return Long.valueOf(this.year);
	}
}