XMLGregorianCalendar

XMLGregorianCalendar

XMLGregorianCalendar()

add

abstract fun add(duration: Duration!): Unit

Add duration to this instance.

The computation is specified in XML Schema 1.0 Part 2, Appendix E, Adding durations to dateTimes>. date/time field mapping table defines the mapping from XML Schema 1.0 dateTime fields to this class' representation of those fields.

clear

abstract fun clear(): Unit

Unset all fields to undefined.

Set all int fields to DatatypeConstants#FIELD_UNDEFINED and reference fields to null.

clone

abstract fun clone(): Any

Creates and returns a copy of this object.

compare

abstract fun compare(xmlGregorianCalendar: XMLGregorianCalendar!): Int

Compare two instances of W3C XML Schema 1.0 date/time datatypes according to partial order relation defined in W3C XML Schema 1.0 Part 2, Section 3.2.7.3, Order relation on dateTime.

xsd:dateTime datatype field mapping to accessors of this class are defined in date/time field mapping table.

equals

open fun equals(other: Any?): Boolean

Indicates whether parameter obj is "equal to" this one.

getDay

abstract fun getDay(): Int

Return day in month or DatatypeConstants#FIELD_UNDEFINED.

Value constraints for this value are summarized in day field of date/time field mapping table.

getEon

abstract fun getEon(): BigInteger!

Return high order component for XML Schema 1.0 dateTime datatype field for year. null if this optional part of the year field is not defined.

Value constraints for this value are summarized in year field of date/time field mapping table.

getEonAndYear

abstract fun getEonAndYear(): BigInteger!

Return XML Schema 1.0 dateTime datatype field for year.

Value constraints for this value are summarized in year field of date/time field mapping table.

getFractionalSecond

abstract fun getFractionalSecond(): BigDecimal!

Return fractional seconds.

null is returned when this optional field is not defined.

Value constraints are detailed in second field of date/time field mapping table.

This optional field can only have a defined value when the xs:dateTime second field, represented by getSecond(), does not return DatatypeConstants#FIELD_UNDEFINED.

getHour

abstract fun getHour(): Int

Return hours or DatatypeConstants#FIELD_UNDEFINED. Returns DatatypeConstants#FIELD_UNDEFINED if this field is not defined.

Value constraints for this value are summarized in hour field of date/time field mapping table.

getMillisecond

open fun getMillisecond(): Int

Return millisecond precision of getFractionalSecond().

This method represents a convenience accessor to infinite precision fractional second value returned by getFractionalSecond(). The returned value is the rounded down to milliseconds value of getFractionalSecond(). When getFractionalSecond() returns null, this method must return DatatypeConstants#FIELD_UNDEFINED.

Value constraints for this value are summarized in second field of date/time field mapping table.

getMinute

abstract fun getMinute(): Int

Return minutes or .

Value constraints for this value are summarized in minute field of date/time field mapping table.

getMonth

abstract fun getMonth(): Int

Return number of month or DatatypeConstants#FIELD_UNDEFINED.

Value constraints for this value are summarized in month field of date/time field mapping table.

getSecond

abstract fun getSecond(): Int

Return seconds or DatatypeConstants#FIELD_UNDEFINED.

Returns DatatypeConstants#FIELD_UNDEFINED if this field is not defined. When this field is not defined, the optional xs:dateTime fractional seconds field, represented by getFractionalSecond() and getMillisecond(), must not be defined.

Value constraints for this value are summarized in second field of date/time field mapping table.

getTimeZone

abstract fun getTimeZone(defaultZoneoffset: Int): TimeZone!

Returns a java.util.TimeZone for this class.

If timezone field is defined for this instance, returns TimeZone initialized with custom timezone id of zoneoffset. If timezone field is undefined, try the defaultZoneoffset that was passed in. If defaultZoneoffset is FIELD_UNDEFINED, return default timezone for this host. (Same default as java.util.GregorianCalendar).

getTimezone

abstract fun getTimezone(): Int

Return timezone offset in minutes or DatatypeConstants#FIELD_UNDEFINED if this optional field is not defined.

Value constraints for this value are summarized in timezone field of date/time field mapping table.

getXMLSchemaType

abstract fun getXMLSchemaType(): QName!

Return the name of the XML Schema date/time type that this instance maps to. Type is computed based on fields that are set.

getYear

abstract fun getYear(): Int

Return low order component for XML Schema 1.0 dateTime datatype field for year or DatatypeConstants#FIELD_UNDEFINED.

Value constraints for this value are summarized in year field of date/time field mapping table.

hashCode

open fun hashCode(): Int

Returns a hash code consistent with the definition of the equals method.

isValid

abstract fun isValid(): Boolean

Validate instance by getXMLSchemaType() constraints.

normalize

abstract fun normalize(): XMLGregorianCalendar!

Normalize this instance to UTC.

2000-03-04T23:00:00+03:00 normalizes to 2000-03-04T20:00:00Z

Implements W3C XML Schema Part 2, Section 3.2.7.3 (A).

reset

abstract fun reset(): Unit

Reset this XMLGregorianCalendar to its original values.

XMLGregorianCalendar is reset to the same values as when it was created with DatatypeFactory#newXMLGregorianCalendar(), DatatypeFactory#newXMLGregorianCalendar(String lexicalRepresentation), DatatypeFactory#newXMLGregorianCalendar(, DatatypeFactory#newXMLGregorianCalendar(, DatatypeFactory#newXMLGregorianCalendar(GregorianCalendar cal), DatatypeFactory#newXMLGregorianCalendarDate(, DatatypeFactory#newXMLGregorianCalendarTime(, DatatypeFactory#newXMLGregorianCalendarTime( or DatatypeFactory#newXMLGregorianCalendarTime(.

reset() is designed to allow the reuse of existing XMLGregorianCalendars thus saving resources associated with the creation of new XMLGregorianCalendars.

setDay

abstract fun setDay(day: Int): Unit

Set days in month.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

setFractionalSecond

abstract fun setFractionalSecond(fractional: BigDecimal!): Unit

Set fractional seconds.

Unset this field by invoking the setter with a parameter value of null.

setHour

abstract fun setHour(hour: Int): Unit

Set hours.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

setMillisecond

abstract fun setMillisecond(millisecond: Int): Unit

Set milliseconds.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

setMinute

abstract fun setMinute(minute: Int): Unit

Set minutes.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

setMonth

abstract fun setMonth(month: Int): Unit

Set month.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

setSecond

abstract fun setSecond(second: Int): Unit

Set seconds.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

setTime

open fun setTime(
    hour: Int, 
    minute: Int, 
    second: Int
): Unit

Set time as one unit.

setTime

open fun setTime(
    hour: Int, 
    minute: Int, 
    second: Int, 
    fractional: BigDecimal!
): Unit

Set time as one unit, including the optional infinite precision fractional seconds.

setTime

open fun setTime(
    hour: Int, 
    minute: Int, 
    second: Int, 
    millisecond: Int
): Unit

Set time as one unit, including optional milliseconds.

setTimezone

abstract fun setTimezone(offset: Int): Unit

Set the number of minutes in the timezone offset.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

setYear

abstract fun setYear(year: BigInteger!): Unit

Set low and high order component of XSD dateTime year field.

Unset this field by invoking the setter with a parameter value of null.

setYear

abstract fun setYear(year: Int): Unit

Set year of XSD dateTime year field.

Unset this field by invoking the setter with a parameter value of DatatypeConstants#FIELD_UNDEFINED.

Note: if the absolute value of the year parameter is less than 10^9, the eon component of the XSD year field is set to null by this method.

toGregorianCalendar

abstract fun toGregorianCalendar(): GregorianCalendar!

Convert this XMLGregorianCalendar to a GregorianCalendar.

When this instance has an undefined field, this conversion relies on the java.util.GregorianCalendar default for its corresponding field. A notable difference between XML Schema 1.0 date/time datatypes and java.util.GregorianCalendar is that Timezone value is optional for date/time datatypes and it is a required field for java.util.GregorianCalendar. See javadoc for java.util.TimeZone.getDefault() on how the default is determined. To explicitly specify the TimeZone instance, see #toGregorianCalendar(java.util.TimeZone,Locale,javax.xml.datatype.XMLGregorianCalendar).

To ensure consistency in conversion implementations, the new GregorianCalendar should be instantiated in following manner.

• Using timeZone value as defined above, create a new java.util.GregorianCalendar(timeZone,Locale.getDefault()).
• Initialize all GregorianCalendar fields by calling {(@link GegorianCalendar#clear()}.
• Obtain a pure Gregorian Calendar by invoking GregorianCalendar.setGregorianChange( new Date(Long.MIN_VALUE)).
• Its fields ERA, YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND and MILLISECOND are set using the method Calendar.set(int,int)

toGregorianCalendar

abstract fun toGregorianCalendar(
    timezone: TimeZone!, 
    aLocale: Locale!, 
    defaults: XMLGregorianCalendar!
): GregorianCalendar!

Convert this XMLGregorianCalendar along with provided parameters to a GregorianCalendar instance.

Since XML Schema 1.0 date/time datetypes has no concept of timezone ids or daylight savings timezone ids, this conversion operation allows the user to explicitly specify one with timezone parameter.

To compute the return value's TimeZone field,

• when parameter timeZone is non-null, it is the timezone field.
• else when this.getTimezone() != FIELD_UNDEFINED, create a java.util.TimeZone with a custom timezone id using the this.getTimezone().
• else when defaults.getTimezone() != FIELD_UNDEFINED, create a java.util.TimeZone with a custom timezone id using defaults.getTimezone().
• else use the GregorianCalendar default timezone value for the host is defined as specified by java.util.TimeZone.getDefault().

To ensure consistency in conversion implementations, the new GregorianCalendar should be instantiated in following manner.

• Create a new java.util.GregorianCalendar(TimeZone, Locale) with TimeZone set as specified above and the Locale parameter.
• Initialize all GregorianCalendar fields by calling GregorianCalendar#clear()
• Obtain a pure Gregorian Calendar by invoking GregorianCalendar.setGregorianChange( new Date(Long.MIN_VALUE)).
• Its fields ERA, YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND and MILLISECOND are set using the method Calendar.set(int,int)

toString

open fun toString(): String

Returns a String representation of this XMLGregorianCalendar Object.

The result is a lexical representation generated by toXMLFormat().

toXMLFormat

abstract fun toXMLFormat(): String!

Return the lexical representation of this instance. The format is specified in XML Schema 1.0 Part 2, Section 3.2.[7-14].1, Lexical Representation".

Specific target lexical representation format is determined by getXMLSchemaType().