javax.xml.datatype
类 XMLGregorianCalendar

java.lang.Object
  javax.xml.datatype.XMLGregorianCalendar

所有已实现的接口：

Cloneable

public abstract class XMLGregorianCalendar
     

      extends 
      Object
     
     

      implements 
      Cloneable
     

W3C XML 模式 1.0 日期/时间数据类型的表示形式。明确地说，这些日期/时间数据类型是 XML 名称空间 "http://www.w3.org/2001/XMLSchema" 中定义的 dateTime、time、date、gYearMonth、gMonthDay、gYear gMonth 和 gDay。在 W3C XML 模式 1.0 第二部分 3.2.7-14 节中以标准形式定义了这些数据类型。

下表定义了 XML 模式 1.0 日期/时间数据类型字段和此类的字段之间的映射关系。还总结了 W3C XML 模式 1.0 第二部分的附录 D ISO 8601 Date and Time Formats 中定义的日期和时间字段的值约束。

通过此类的工厂方法、DatatypeFactory、设置方法和解析方法检查上面表中为字段列出的所有最大值空间约束。若参数的值超出字段的值约束，或者复合值组成一个无效 XMLGregorianCalendar 实例（例如，如果指定六月的第 31 日），则抛出 IllegalArgumentException。

为此类定义以下操作：

• 用于独立日期/时间字段的 accessors/mutators
• 此类与 W3C XML 模式 1.0 词汇表示形式、toString()、DatatypeFactory.newXMLGregorianCalendar(String lexicalRepresentation) 之间的转换
• 此类与 GregorianCalendar、toGregorianCalendar(java.util.TimeZone timezone, java.util.Locale aLocale, XMLGregorianCalendar defaults)、DatatypeFactory 之间的转换
• 部分顺序关系比较器方法 compare(XMLGregorianCalendar xmlGregorianCalendar)
• 相对于 compare(XMLGregorianCalendar xmlGregorianCalendar) 定义的 equals(Object)。
• W3C XML 模式 1.0 第二部分的附录 E Adding durations to dateTimes 中定义的 Duration 实例的其他操作。

从以下版本开始：

1.5

另请参见：

Duration, DatatypeFactory

XMLGregorianCalendar

public XMLGregorianCalendar()

默认的无参数构造方法。

注：总是使用 DatatypeFactory 来构造 XMLGregorianCalendar 实例。无法保证该类上的构造方法生成具有一致状态且可在以后移除的对象。

clear

public abstract void clear()

取消设置所有未定义的字段。

将所有 int 字段设置为 DatatypeConstants.FIELD_UNDEFINED，并将引用字段设置为 null。

reset

public abstract void reset()

将此 XMLGregorianCalendar 重设为其原始值。

将 XMLGregorianCalendar 重置为与使用 DatatypeFactory.newXMLGregorianCalendar()、DatatypeFactory.newXMLGregorianCalendar(String lexicalRepresentation)、DatatypeFactory.newXMLGregorianCalendar( BigInteger year, int month, int day, int hour, int minute, int second, BigDecimal fractionalSecond, int timezone)、DatatypeFactory.newXMLGregorianCalendar( int year, int month, int day, int hour, int minute, int second, int millisecond, int timezone)、DatatypeFactory.newXMLGregorianCalendar(GregorianCalendar cal)、DatatypeFactory.newXMLGregorianCalendarDate( int year, int month, int day, int timezone)、DatatypeFactory.newXMLGregorianCalendarTime( int hours, int minutes, int seconds, int timezone)、DatatypeFactory.newXMLGregorianCalendarTime( int hours, int minutes, int seconds, BigDecimal fractionalSecond, int timezone) 或 DatatypeFactory.newXMLGregorianCalendarTime( int hours, int minutes, int seconds, int milliseconds, int timezone) 创建时相同的值。

reset() 的设计目的是允许重用现有的 XMLGregorianCalendar，从而节省与创建新 XMLGregorianCalendar 相关的资源。

setYear

public abstract void setYear(BigInteger year)

设置 XSD dateTime year 字段的低和高顺序组件。

通过使用参数值 null 调用设置方法取消设置此字段。

参数：

year - 日期/时间字段映射表中 year 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 year 参数超出 日期/时间映射表中指定字段的值约束。

setYear

public abstract void setYear(int year)

设置 XSD dateTime year 字段的年。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

注：如果 year 参数的绝对值小于 10^9，则通过此方法将 XSD year 字段的 eon 组件设置为 null。

参数：

year - 日期/时间字段映射表中 year 字段中总结的值约束。如果 year 是 DatatypeConstants.FIELD_UNDEFINED，那么将 eon 设置为 null。

setMonth

public abstract void setMonth(int month)

设置月。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

参数：

month - 日期/时间映射表的 month 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 month 参数超出 日期/时间映射表中指定字段的值约束。

setDay

public abstract void setDay(int day)

设置月中的日。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

参数：

day - 日期/时间字段映射表的 day 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 day 参数超出 日期/时间映射表中指定字段的值约束。

setTimezone

public abstract void setTimezone(int offset)

设置时区偏移量中的分钟数。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

参数：

offset - 日期/时间字段映射表的 timezone 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 offset 参数超出 日期/时间映射表中指定字段的值约束。

setTime

public void setTime(int hour,
                    int minute,
                    int second)

将时间设置为一个单元。

参数：

hour - 日期/时间字段映射表的 hour 字段中总结的值约束。

minute - 日期/时间字段映射表的 minute 字段中总结的值约束。

second - 日期/时间字段映射表的 second 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果任何参数超出 日期/时间映射表中指定字段的值约束。

另请参见：

setTime(int, int, int, BigDecimal)

setHour

public abstract void setHour(int hour)

设置小时。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

参数：

hour - 日期/时间字段映射表的 hour 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 hour 参数超出 日期/时间映射表中指定字段的值约束。

setMinute

public abstract void setMinute(int minute)

设置分。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

参数：

minute - 日期/时间字段映射表的 minute 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 minute 参数超出 日期/时间映射表中指定字段的值约束。

setSecond

public abstract void setSecond(int second)

设置秒。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

参数：

second - 日期/时间字段映射表的 second 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 second 参数超出 日期/时间映射表中指定字段的值约束。

setMillisecond

public abstract void setMillisecond(int millisecond)

设置毫秒。

通过使用 DatatypeConstants.FIELD_UNDEFINED 的参数值调用设置方法取消设置此字段。

参数：

millisecond - 日期/时间字段映射表的 second 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 millisecond 参数超出 日期/时间映射表中指定字段的值约束。

setFractionalSecond

public abstract void setFractionalSecond(BigDecimal fractional)

设置小数秒。

通过使用参数值 null 调用设置方法取消设置此字段。

参数：

fractional - 日期/时间字段映射表的 second 字段中总结的值约束。

抛出：

IllegalArgumentException - 如果 fractional 参数超出 日期/时间映射表中指定字段的值约束。

setTime

public void setTime(int hour,
                    int minute,
                    int second,
                    BigDecimal fractional)

将时间设置为一个单元，包括可选无限精度小数秒。

参数：

hour - 日期/时间字段映射表的 hour 字段中总结的值约束。

minute - 日期/时间字段映射表的 minute 字段中总结的值约束。

second - 日期/时间字段映射表的 second 字段中总结的值约束。

fractional - 值 null 指示不设置此可选字段。

抛出：

IllegalArgumentException - 如果任何参数超出 日期/时间映射表中指定字段的值约束。

setTime

public void setTime(int hour,
                    int minute,
                    int second,
                    int millisecond)

将时间设置为一个单元，包括可选的毫秒。

参数：

hour - 日期/时间字段映射表的 hour 字段中总结的值约束。

minute - 日期/时间字段映射表的 minute 字段中总结的值约束。

second - 日期/时间字段映射表的 second 字段中总结的值约束。

millisecond - DatatypeConstants.FIELD_UNDEFINED 的值指示未设置此可选字段。

抛出：

IllegalArgumentException - 如果任何参数超出 日期/时间映射表中指定字段的值约束。

getEon

public abstract BigInteger getEon()

返回 year XML 模式 1.0 日期时间数据类型字段的高顺序组件。如果未定义 year 字段的此可选部分，则返回 null。

日期/时间字段映射表中 year 字段中总结了此值的值约束。

返回：

此 XMLGregorianCalendar 的 eon。返回的值是 10^9 的整数倍数。

另请参见：

getYear(), getEonAndYear()

getYear

public abstract int getYear()

返回 year 或 DatatypeConstants.FIELD_UNDEFINED XML 模式 1.0 日期时间数据类型字段的低顺序组件。

日期/时间字段映射表中 year 字段中总结了此值的值约束。

返回：

此 XMLGregorianCalendar 的年。

另请参见：

getEon(), getEonAndYear()

getEonAndYear

public abstract BigInteger getEonAndYear()

返回 year XML 模式 1.0 的日期时间数据类型字段。

日期/时间字段映射表中 year 字段中总结了此值的值约束。

返回：

当同时定义了 eon 和 BigInteger.valueOf(year) 两个字段时，返回它们的总和。只定义了 year 时，返回 year。当 eon 和 year 都未定义时，返回 null。

另请参见：

getEon(), getYear()

getMonth

public abstract int getMonth()

返回月数或 DatatypeConstants.FIELD_UNDEFINED。

日期/时间映射表的 month 字段中总结了此值的值约束。

返回：

此 XMLGregorianCalendar 的年。

getDay

public abstract int getDay()

返回月中的日或 DatatypeConstants.FIELD_UNDEFINED。

日期/时间字段映射表的 day 字段中总结了此值的值约束。

另请参见：

setDay(int)

getTimezone

public abstract int getTimezone()

返回以分为单位的时区偏移量，如果未定义此可选字段，则返回 DatatypeConstants.FIELD_UNDEFINED。

日期/时间字段映射表的 timezone 字段中总结了此值的值约束。

另请参见：

setTimezone(int)

getHour

public abstract int getHour()

返回时或 DatatypeConstants.FIELD_UNDEFINED。如果未定义此字段，则返回 DatatypeConstants.FIELD_UNDEFINED。

日期/时间字段映射表的 hour 字段中总结了此值的值约束。

另请参见：

setTime(int, int, int)

getMinute

public abstract int getMinute()

返回分或 DatatypeConstants.FIELD_UNDEFINED。

如果未定义此字段，则返回 DatatypeConstants.FIELD_UNDEFINED。

日期/时间字段映射表的 minute 字段中总结了此值的值约束。

另请参见：

setTime(int, int, int)

getSecond

public abstract int getSecond()

返回秒或 DatatypeConstants.FIELD_UNDEFINED。

如果未定义此字段，则返回 DatatypeConstants.FIELD_UNDEFINED。当未定义此字段时，不得定义由 getFractionalSecond() 和 getMillisecond() 表示的可选 xs:dateTime 小数 seconds 字段。

日期/时间字段映射表的 second 字段中总结此值的值约束。

返回：

此 XMLGregorianCalendar 的秒。

另请参见：

getFractionalSecond(), getMillisecond(), setTime(int, int, int)

getMillisecond

public int getMillisecond()

返回 getFractionalSecond() 的毫秒精度。

此方法表示由 getFractionalSecond() 返回的无限精度小数秒值的有用存取程序。返回的值是 getFractionalSecond() 的毫秒值的下舍入值。当 getFractionalSecond() 返回 null 时，此方法必须返回 DatatypeConstants.FIELD_UNDEFINED。

日期/时间字段映射表的 second 字段中总结此值的值约束。

返回：

此 XMLGregorianCalendar 的毫秒。

另请参见：

getFractionalSecond(), setTime(int, int, int)

getFractionalSecond

public abstract BigDecimal getFractionalSecond()

返回小数秒。

当未定义此可选字段时，返回 null。

在 日期/时间字段映射表的 second 字段中详细描述了值约束。

当 getSecond() 表示的 xs:dateTime 秒字段未返回 DatatypeConstants.FIELD_UNDEFINED 时，此可选字段只能有一个已定义的值。

返回：

此 XMLGregorianCalendar 的小数秒。

另请参见：

getSecond(), setTime(int, int, int, BigDecimal)

compare

public abstract int compare(XMLGregorianCalendar xmlGregorianCalendar)

根据 W3C XML 模式 1.0 第二部分 3.2.7.3 小节 Order relation on dateTime 中定义的部分顺序关系，比较 W3C XML 模式 1.0 日期/时间数据类型的两个实例。

在日期/时间映射表中定义了到此类的存取程序的 xsd:dateTime 数据类型字段映射。

参数：

xmlGregorianCalendar - 要比较的 XMLGregorianCalendar 实例

返回：

此 XMLGregorianCalendar 与 xmlGregorianCalendar 之间的关系： DatatypeConstants.LESSER、