com.ghasemkiani.util.DateFields Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of persiancalendar Show documentation
Persian Calendar is an implementation of the Iranian (Jalali) calendar based on the ICU4J calendar framework.
The newest version!
/*
	DateFields.java
	2003-09-24 21:31:46
	Copyright C Ghasem Kiani 
	
	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.
	
	This program 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 General Public License for more details.
	
	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/

package com.ghasemkiani.util;

/**
	This class holds the fields of Persian date, i.e., the Persian year,
	month, and day. {@link SimplePersianCalendar} uses this class to
	set/get the Persian date.
	
	@author Ghasem Kiani
	@version 2.1
*/
public class DateFields
{
	/**
		This field denotes the Persian year.
	*/
	private int year;
	/**
		Accessor method to assign a new value to year.
		@param year The new value to be assigned to year.
	*/
	public void setYear(int year)
	{
		this.year = year;
	}
	/**
		Accessor method to get the value of year.
		@return The value of year.
	*/
	public int getYear()
	{
		 return year;
	}

	/**
		This field denotes the Persian month.
		Note: month is zero-based.
		See constants in {@link PersianCalendarConstants}.
	*/
	private int month;
	/**
		Accessor method to assign a new value to month.
		@param month The new value to be assigned to month.
	*/
	public void setMonth(int month)
	{
		this.month = month;
	}
	/**
		Accessor method to get the value of month.
		@return The value of month.
	*/
	public int getMonth()
	{
		 return month;
	}

	/**
		This field denotes the Persian day.
	*/
	private int day;
	/**
		Accessor method to assign a new value to day.
		@param day The new value to be assigned to day.
	*/
	public void setDay(int day)
	{
		this.day = day;
	}
	/**
		Accessor method to get the value of day.
		@return The value of day.
	*/
	public int getDay()
	{
		 return day;
	}
	/**
		Constructs a DateFields object with the date fields initialized to 0.
	*/
	public DateFields()
	{
		this(0, 0, 0);
	}
	/**
		Constructs a DateFields object with the given date fields.
		
		@param year the Persian year.
		@param month the Persian month (zero-based).
		@param day the Persian day of month.
	*/
	public DateFields(int year, int month, int day)
	{
		super();
		setYear(year);
		setMonth(month);
		setDay(day);
	}
	/**
		This method returns a usable string representation of this object.
		Month is incremented to show one-based Persian month index.
		
		@return a usable string representation of this object.
	*/
	public String toString()
	{
		return "" + year + "/" + (month + 1) + "/" + day;
	}
}