GMonth (Castor XML - core 1.4.1 API)

java.lang.Object
- org.exolab.castor.types.DateTimeBase
- - org.exolab.castor.types.GMonth

All Implemented Interfaces:

Serializable, Cloneable
```
public class GMonth
extends DateTimeBase
```
Describe an XML schema gMonth type.
The format is defined by W3C XML Schema Recommendation and ISO8601 i.e --MM--(Z|(+|-)hh:mm)

Version:

$Revision$

Author:

Arnaud Blandin, Edward Kuns

See Also:

Serialized Form

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

Constructors
Constructor and Description
`GMonth()` public only for the generated source code
`GMonth(int month)` Constructs a XML Schema GMonth instance given all the values of the different fields.
`GMonth(short month)` Constructs a XML Schema GMonth instance given all the values of the different fields.
`GMonth(String gmonth)` Constructs a GMonth from a string value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`short`	`getCentury()`
`short`	`getDay()`
`short`	`getHour()`
`short`	`getMilli()`
`short`	`getMinute()`
`short`	`getSeconds()`
`short[]`	`getValues()` Returns an array of short with all the fields that describe this gDay type.
`short`	`getYear()`
`boolean`	`hasCentury()`
`boolean`	`hasDay()`
`boolean`	`hasHour()`
`boolean`	`hasIsNegative()`
`boolean`	`hasMilli()`
`boolean`	`hasMinute()`
`boolean`	`hasSeconds()`
`boolean`	`hasYear()`
`boolean`	`isNegative()`
`static Object`	`parse(String str)` parse a String and convert it into an java.lang.Object
`static GMonth`	`parseGMonth(String str)` parse a String and convert it into a GMonth.
`void`	`setCentury(short century)` Set the century field.
`void`	`setDay(short month)` Sets the Day 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`	`setNegative()` 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 array
`void`	`setYear(short year)` Sets the Year field.
`Date`	`toDate()` converts this GMonth into a local java Date.
`String`	`toString()` convert this GMonth to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e --MM--(Z\|(+\|-)hh:mm)

Methods inherited from class org.exolab.castor.types.DateTimeBase
addDuration, appendDateString, appendTimeString, appendTimeZoneString, clone, compareTo, equal, equals, getMonth, getZoneHour, getZoneMinute, hashCode, hasMonth, isLeap, isUTC, isZoneNegative, normalize, parseDay, parseMonth, parseTime, parseTimeZone, parseYear, setDateFormatTimeZone, setDateFormatTimeZone, setMonth, setSecond, setUTC, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GMonth
```
public GMonth()
```
    public only for the generated source code
  - GMonth
```
public GMonth(short month)
```
    Constructs a XML Schema GMonth instance given all the values of the different fields. By default a GMonth is not UTC and is local.
    
    Parameters:
    
    month - the month value.
  - GMonth
```
public GMonth(int month)
```
    Constructs a XML Schema GMonth instance given all the values of the different fields. By default a GMonth is not UTC and is local.
    
    Parameters:
    
    month - the month value.
  - GMonth
```
public GMonth(String gmonth)
       throws ParseException
```
    Constructs a GMonth from a string value.
    
    Parameters:
    
    gmonth - the string representation of the GMonth 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 Detail
  - setValues
```
public void setValues(short[] values)
```
    Sets all the fields by reading the values in an array
    if a Time Zone is specificied it has to be set by using setZone.
    Specified by:
    
    setValues in class DateTimeBase
    
    Parameters:
    values - an array of shorts with the values the array is supposed to be of length 1 and ordered like the following:
    
    Month
  - 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 class DateTimeBase
    
    Returns:
    
    an array of short with all the fields that describe this Date type.
  - toDate
```
public Date toDate()
```
    converts this GMonth into a local java Date.
    
    Specified by:
    
    toDate in class DateTimeBase
    
    Returns:
    
    a local date representing this Date.
  - toString
```
public String toString()
```
    convert this GMonth to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e --MM--(Z|(+|-)hh:mm)
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representing this Date
  - parse
```
public static Object parse(String str)
                    throws ParseException
```
    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)
  - parseGMonth
```
public static GMonth parseGMonth(String str)
                          throws ParseException
```
    parse a String and convert it into a GMonth.
    
    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 class DateTimeBase
  - isNegative
```
public boolean isNegative()
```
    Overrides:
    
    isNegative in class DateTimeBase
  - setNegative
```
public void setNegative()
```
    Description copied from class: DateTimeBase
    
    Set the negative field to true.
    
    Overrides:
    
    setNegative in class DateTimeBase
  - hasCentury
```
public boolean hasCentury()
```
    Overrides:
    
    hasCentury in class DateTimeBase
  - getCentury
```
public short getCentury()
```
    Overrides:
    
    getCentury in class DateTimeBase
  - setCentury
```
public void setCentury(short century)
```
    Description copied from class: DateTimeBase
    
    Set the century field. Note: year 0000 is not allowed.
    
    Overrides:
    
    setCentury in class DateTimeBase
    
    Parameters:
    
    century - the value to set
  - hasYear
```
public boolean hasYear()
```
    Overrides:
    
    hasYear in class DateTimeBase
  - getYear
```
public short getYear()
```
    Overrides:
    
    getYear in class DateTimeBase
  - setYear
```
public void setYear(short year)
```
    Description copied from class: DateTimeBase
    
    Sets the Year field. Note: year 0000 is not allowed.
    
    Overrides:
    
    setYear in class DateTimeBase
    
    Parameters:
    
    year - the year to set
  - hasDay
```
public boolean hasDay()
```
    Overrides:
    
    hasDay in class DateTimeBase
  - getDay
```
public short getDay()
```
    Overrides:
    
    getDay in class DateTimeBase
  - setDay
```
public void setDay(short month)
```
    Description copied from class: DateTimeBase
    
    Sets the Day Field. Note: This field is validated before the assignment is done.
    
    Overrides:
    
    setDay in class DateTimeBase
    
    Parameters:
    
    month - the value to set up
  - hasHour
```
public boolean hasHour()
```
    Overrides:
    
    hasHour in class DateTimeBase
  - getHour
```
public short getHour()
```
    Overrides:
    
    getHour in class DateTimeBase
  - setHour
```
public void setHour(short hour)
```
    Description copied from class: DateTimeBase
    
    Sets the hour field for this date/time type.
    
    Overrides:
    
    setHour in class DateTimeBase
    
    Parameters:
    
    hour - the hour to set
  - hasMinute
```
public boolean hasMinute()
```
    Overrides:
    
    hasMinute in class DateTimeBase
  - getMinute
```
public short getMinute()
```
    Overrides:
    
    getMinute in class DateTimeBase
  - setMinute
```
public void setMinute(short minute)
```
    Description copied from class: DateTimeBase
    
    set the minute field for this date/time type.
    
    Overrides:
    
    setMinute in class DateTimeBase
    
    Parameters:
    
    minute - the minute to set.
  - hasSeconds
```
public boolean hasSeconds()
```
    Overrides:
    
    hasSeconds in class DateTimeBase
  - getSeconds
```
public short getSeconds()
```
    Overrides:
    
    getSeconds in class DateTimeBase
  - 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 class DateTimeBase
    
    Parameters:
    
    second - the second to set
  - hasMilli
```
public boolean hasMilli()
```
    Overrides:
    
    hasMilli in class DateTimeBase
  - getMilli
```
public short getMilli()
```
    Overrides:
    
    getMilli in class DateTimeBase
  - setMilliSecond
```
public void setMilliSecond(short millisecond)
```
    Description copied from class: DateTimeBase
    
    Sets the millisecond field for this date/time type.
    
    Overrides:
    
    setMilliSecond in class DateTimeBase
    
    Parameters:
    
    millisecond - the millisecond to set

Class GMonth

Field Summary

Fields inherited from class org.exolab.castor.types.DateTimeBase

Constructor Summary

Method Summary

Methods inherited from class org.exolab.castor.types.DateTimeBase

Methods inherited from class java.lang.Object

Constructor Detail

GMonth

GMonth

GMonth

GMonth

Method Detail

setValues

getValues

toDate

toString

parse

parseGMonth

hasIsNegative

isNegative

setNegative

hasCentury

getCentury

setCentury

hasYear

getYear

setYear

hasDay

getDay

setDay

hasHour

getHour

setHour

hasMinute

getMinute

setMinute

hasSeconds

getSeconds

setSecond

hasMilli

getMilli

setMilliSecond