Class GMonthDay
java.lang.Object
org.exolab.castor.types.DateTimeBase
org.exolab.castor.types.GMonthDay
- All Implemented Interfaces:
Serializable,Cloneable
Describe an XML schema gMonthDay type.
The format is defined by W3C XML Schema Recommendation and ISO8601 i.e --MM-DD(Z|(+|-)hh:mm)
- Version:
- $Revision: 7289 $
- Author:
- Arnaud Blandin, Edward Kuns
- See Also:
-
Field Summary
Fields inherited from class org.exolab.castor.types.DateTimeBase
EQUALS, GREATER_THAN, INDETERMINATE, LESS_THAN, MAX_TIME_ZONE_COMPARISON_OFFSET, WRONGLY_PLACED -
Constructor Summary
ConstructorsConstructorDescriptionpublic only for the generated source codeGMonthDay(int month, int day) Instantiates a new gMonthDay given the value of the month and the value of the day.GMonthDay(short[] values) Constructs a XML Schema GMonthDay instance given all the values of the different fields.GMonthDay(short month, short day) Instantiates a new gMonthDay given the value of the month and the value of the day.Construct a GMonthDay from a string value -
Method Summary
Modifier and TypeMethodDescriptionshortshortgetHour()shortgetMilli()shortshortshort[]Returns an array of short with all the fields that describe this gMonthDay type.shortgetYear()booleanbooleanhasHour()boolean//////////////////////// DISALLOWED METHODS ///////////////////////////booleanhasMilli()booleanbooleanbooleanhasYear()boolean/////////////////////Getter methods//////////////////////////////////////static Objectparse a String and convert it into an java.lang.Objectstatic GMonthDayparseGMonthDay(String str) parse a String and convert it into a gMonthDay.voidsetCentury(short century) Set the century field.voidsetHour(short hour) Sets the hour field for this date/time type.voidsetMilliSecond(short millisecond) Sets the millisecond field for this date/time type.voidsetMinute(short minute) set the minute field for this date/time type.voidSet the negative field to true.voidsetSecond(short second) Sets the seconds field for this date/time type, not including the fractional seconds.voidsetValues(short[] values) Sets all the fields by reading the values in an arrayvoidsetYear(short year) Sets the Year field.toDate()converts this gMonthDay into a local java Date.toString()convert this gMonthDay to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e --MM-DD(Z|(+|-)hh:mm)Methods inherited from class org.exolab.castor.types.DateTimeBase
addDuration, appendDateString, appendTimeString, appendTimeZoneString, clone, compareTo, equal, equals, getDay, getMonth, getZoneHour, getZoneMinute, hasDay, hashCode, hasMonth, isLeap, isUTC, isZoneNegative, normalize, parseDay, parseMonth, parseTime, parseTimeZone, parseYear, setDateFormatTimeZone, setDateFormatTimeZone, setDay, setMonth, setSecond, setUTC, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar
-
Constructor Details
-
GMonthDay
public GMonthDay()public only for the generated source code -
GMonthDay
public GMonthDay(short month, short day) Instantiates a new gMonthDay given the value of the month and the value of the day.- Parameters:
month- the month valueday- the day value
-
GMonthDay
public GMonthDay(int month, int day) Instantiates a new gMonthDay given the value of the month and the value of the day.- Parameters:
month- the month valueday- the day value
-
GMonthDay
public GMonthDay(short[] values) Constructs a XML Schema GMonthDay instance given all the values of the different fields. By default a GMonthDay is not UTC and is local.- Parameters:
values- an array of shorts that represent the different fields of Time.
-
GMonthDay
Construct a GMonthDay from a string value- Parameters:
gmonthDay- the string representation of the GMonthDay to instantiate- Throws:
ParseException- a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)
-
-
Method Details
-
setValues
public void setValues(short[] values) Sets all the fields by reading the values in an arrayif a Time Zone is specificied it has to be set by using
setZone.- Specified by:
setValuesin classDateTimeBase- Parameters:
values- an array of shorts with the values the array is supposed to be of length 2 and ordered like the following:- Month
- Day
-
getValues
public short[] getValues()Returns an array of short with all the fields that describe this gMonthDay type.Note:the time zone is not included.
- Specified by:
getValuesin classDateTimeBase- Returns:
- an array of short with all the fields that describe this Date type.
-
toDate
converts this gMonthDay into a local java Date.- Specified by:
toDatein classDateTimeBase- Returns:
- a local date representing this Date.
-
toString
-
parse
parse a String and convert it into an java.lang.Object- Parameters:
str- the string to parse- Returns:
- an Object represented by the string
- Throws:
ParseException- a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)
-
parseGMonthDay
parse a String and convert it into a gMonthDay.- Parameters:
str- the string to parse- Returns:
- the Date represented by the string
- Throws:
ParseException- a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)
-
hasIsNegative
public boolean hasIsNegative()//////////////////////// DISALLOWED METHODS ///////////////////////////- Overrides:
hasIsNegativein classDateTimeBase
-
isNegative
public boolean isNegative()Description copied from class:DateTimeBase/////////////////////Getter methods//////////////////////////////////////- Overrides:
isNegativein classDateTimeBase
-
setNegative
public void setNegative()Description copied from class:DateTimeBaseSet the negative field to true.- Overrides:
setNegativein classDateTimeBase
-
hasCentury
public boolean hasCentury()- Overrides:
hasCenturyin classDateTimeBase
-
getCentury
public short getCentury()- Overrides:
getCenturyin classDateTimeBase
-
setCentury
public void setCentury(short century) Description copied from class:DateTimeBaseSet the century field. Note: year 0000 is not allowed.- Overrides:
setCenturyin classDateTimeBase- Parameters:
century- the value to set
-
hasYear
public boolean hasYear()- Overrides:
hasYearin classDateTimeBase
-
getYear
public short getYear()- Overrides:
getYearin classDateTimeBase
-
setYear
public void setYear(short year) Description copied from class:DateTimeBaseSets the Year field. Note: year 0000 is not allowed.- Overrides:
setYearin classDateTimeBase- Parameters:
year- the year to set
-
hasHour
public boolean hasHour()- Overrides:
hasHourin classDateTimeBase
-
getHour
public short getHour()- Overrides:
getHourin classDateTimeBase
-
setHour
public void setHour(short hour) Description copied from class:DateTimeBaseSets the hour field for this date/time type.- Overrides:
setHourin classDateTimeBase- Parameters:
hour- the hour to set
-
hasMinute
public boolean hasMinute()- Overrides:
hasMinutein classDateTimeBase
-
getMinute
public short getMinute()- Overrides:
getMinutein classDateTimeBase
-
setMinute
public void setMinute(short minute) Description copied from class:DateTimeBaseset the minute field for this date/time type.- Overrides:
setMinutein classDateTimeBase- Parameters:
minute- the minute to set.
-
hasSeconds
public boolean hasSeconds()- Overrides:
hasSecondsin classDateTimeBase
-
getSeconds
public short getSeconds()- Overrides:
getSecondsin classDateTimeBase
-
setSecond
public void setSecond(short second) Description copied from class:DateTimeBaseSets the seconds field for this date/time type, not including the fractional seconds. Any fractional seconds previously set is unmodified.- Overrides:
setSecondin classDateTimeBase- Parameters:
second- the second to set
-
hasMilli
public boolean hasMilli()- Overrides:
hasMilliin classDateTimeBase
-
getMilli
public short getMilli()- Overrides:
getMilliin classDateTimeBase
-
setMilliSecond
public void setMilliSecond(short millisecond) Description copied from class:DateTimeBaseSets the millisecond field for this date/time type.- Overrides:
setMilliSecondin classDateTimeBase- Parameters:
millisecond- the millisecond to set
-