Package org.exolab.castor.types
Class GDay
java.lang.Object
org.exolab.castor.types.DateTimeBase
org.exolab.castor.types.GDay
- All Implemented Interfaces:
Serializable
,Cloneable
Describe an XML schema gDay type.
The format is defined by W3C XML Schema Recommendation and ISO8601 i.e ---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
ConstructorsConstructorDescriptionGDay()
public only for the generated source codeGDay
(int day) Constructs a XML Schema GDay instance given all the values of the different fields.GDay
(short day) Constructs a XML Schema GDay instance given all the values of the different fields.Constructs a GDay from a string value. -
Method Summary
Modifier and TypeMethodDescriptionshort
short
getHour()
short
getMilli()
short
short
getMonth()
short
short[]
Returns an array of short with all the fields that describe this gDay type.short
getYear()
boolean
boolean
hasHour()
boolean
boolean
hasMilli()
boolean
boolean
hasMonth()
boolean
boolean
hasYear()
boolean
static Object
parse a String and convert it into an java.lang.Objectstatic GDay
parse a String and convert it into a GDay.void
setCentury
(short century) Set the century field.void
setHour
(short hour) Sets the hour field for this date/time type.void
setMilliSecond
(short millisecond) Sets the millisecond field for this date/time type.void
setMinute
(short minute) set the minute field for this date/time type.void
setMonth
(short month) Sets the Month Field.void
Set the negative field to true.void
setSecond
(short second) Sets the seconds field for this date/time type, not including the fractional seconds.void
setValues
(short[] values) Sets all the fields by reading the values in an arrayvoid
setYear
(short year) Sets the Year field.toDate()
converts this GDay into a local java Date.toString()
convert this GDay to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e ---DD(Z|(+|-)hh:mm)Methods inherited from class org.exolab.castor.types.DateTimeBase
addDuration, appendDateString, appendTimeString, appendTimeZoneString, clone, compareTo, equal, equals, getDay, getZoneHour, getZoneMinute, hasDay, hashCode, isLeap, isUTC, isZoneNegative, normalize, parseDay, parseMonth, parseTime, parseTimeZone, parseYear, setDateFormatTimeZone, setDateFormatTimeZone, setDay, setSecond, setUTC, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar
-
Constructor Details
-
GDay
public GDay()public only for the generated source code -
GDay
public GDay(short day) Constructs a XML Schema GDay instance given all the values of the different fields. By default a GDay is not UTC and is local.- Parameters:
day
-
-
GDay
public GDay(int day) Constructs a XML Schema GDay instance given all the values of the different fields. By default a GDay is not UTC and is local.- Parameters:
day
-
-
GDay
Constructs a GDay from a string value.- Parameters:
gday
- the string representation of the GDay 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:
setValues
in classDateTimeBase
- Parameters:
values
- an array of shorts with the values the array is supposed to be of length 1 and ordered like the following:- Day
-
getValues
public short[] getValues()Returns an array of short with all the fields that describe this gDay type.Note:the time zone is not included.
- Specified by:
getValues
in classDateTimeBase
- Returns:
- an array of short with all the fields that describe this Date type.
-
toDate
converts this GDay into a local java Date.- Specified by:
toDate
in classDateTimeBase
- Returns:
- a local date representing this Date.
-
toString
convert this GDay to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e ---DD(Z|(+|-)hh:mm) -
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)
-
parseGDay
parse a String and convert it into a GDay.- 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()- Overrides:
hasIsNegative
in classDateTimeBase
-
isNegative
public boolean isNegative()- Overrides:
isNegative
in classDateTimeBase
-
setNegative
public void setNegative()Description copied from class:DateTimeBase
Set the negative field to true.- Overrides:
setNegative
in classDateTimeBase
-
hasCentury
public boolean hasCentury()- Overrides:
hasCentury
in classDateTimeBase
-
getCentury
public short getCentury()- Overrides:
getCentury
in classDateTimeBase
-
setCentury
public void setCentury(short century) Description copied from class:DateTimeBase
Set the century field. Note: year 0000 is not allowed.- Overrides:
setCentury
in classDateTimeBase
- Parameters:
century
- the value to set
-
hasYear
public boolean hasYear()- Overrides:
hasYear
in classDateTimeBase
-
getYear
public short getYear()- Overrides:
getYear
in classDateTimeBase
-
setYear
public void setYear(short year) Description copied from class:DateTimeBase
Sets the Year field. Note: year 0000 is not allowed.- Overrides:
setYear
in classDateTimeBase
- Parameters:
year
- the year to set
-
hasMonth
public boolean hasMonth()- Overrides:
hasMonth
in classDateTimeBase
-
getMonth
public short getMonth()- Overrides:
getMonth
in classDateTimeBase
-
setMonth
public void setMonth(short month) Description copied from class:DateTimeBase
Sets the Month Field. Note 1 invalid input: '<'= month invalid input: '<'= 12.- Overrides:
setMonth
in classDateTimeBase
- Parameters:
month
- the value to set up
-
hasHour
public boolean hasHour()- Overrides:
hasHour
in classDateTimeBase
-
getHour
public short getHour()- Overrides:
getHour
in classDateTimeBase
-
setHour
public void setHour(short hour) Description copied from class:DateTimeBase
Sets the hour field for this date/time type.- Overrides:
setHour
in classDateTimeBase
- Parameters:
hour
- the hour to set
-
hasMinute
public boolean hasMinute()- Overrides:
hasMinute
in classDateTimeBase
-
getMinute
public short getMinute()- Overrides:
getMinute
in classDateTimeBase
-
setMinute
public void setMinute(short minute) Description copied from class:DateTimeBase
set the minute field for this date/time type.- Overrides:
setMinute
in classDateTimeBase
- Parameters:
minute
- the minute to set.
-
hasSeconds
public boolean hasSeconds()- Overrides:
hasSeconds
in classDateTimeBase
-
getSeconds
public short getSeconds()- Overrides:
getSeconds
in classDateTimeBase
-
setSecond
public void setSecond(short second) Description copied from class:DateTimeBase
Sets the seconds field for this date/time type, not including the fractional seconds. Any fractional seconds previously set is unmodified.- Overrides:
setSecond
in classDateTimeBase
- Parameters:
second
- the second to set
-
hasMilli
public boolean hasMilli()- Overrides:
hasMilli
in classDateTimeBase
-
getMilli
public short getMilli()- Overrides:
getMilli
in classDateTimeBase
-
setMilliSecond
public void setMilliSecond(short millisecond) Description copied from class:DateTimeBase
Sets the millisecond field for this date/time type.- Overrides:
setMilliSecond
in classDateTimeBase
- Parameters:
millisecond
- the millisecond to set
-