Obtain a new instance of a Duration specifying the Duration as isPositive, years, months, days, hours, minutes, seconds.

 

Obtain a new instance of a Duration specifying the Duration as isPositive, years, months, days, hours, minutes, seconds.

The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

A null value indicates that field is not set.

Returns: New Duration created from the specified values.
Parameters:
- isPositive - Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored.
- years - of this Duration
- months - of this Duration
- days - of this Duration
- hours - of this Duration
- minutes - of this Duration
- seconds - of this Duration
Throws:
- IllegalArgumentException - If the values are not a valid representation of a Duration: if all the fields (years, months, ...) are null or if any of the fields is negative.
- UnsupportedOperationException - If implementation cannot support requested values.

  Obtain a new instance of a Duration specifying the Duration as isPositive, years, months, days, hours, minutes, seconds.

 

Obtain a new instance of a Duration specifying the Duration as isPositive, years, months, days, hours, minutes, seconds.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: New Duration created from the specified values.
Parameters:
- isPositive - Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored.
- years - of this Duration
- months - of this Duration
- days - of this Duration
- hours - of this Duration
- minutes - of this Duration
- seconds - of this Duration
Throws:
- IllegalArgumentException - If the values are not a valid representation of a Duration: if any of the fields is negative.
See Also: DatatypeFactory.newDuration( boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds),

  Obtain a new instance of a Duration specifying the Duration as milliseconds.

 

Obtain a new instance of a Duration specifying the Duration as milliseconds.

XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration as:

duration represents a duration of time. The value space of duration is a six-dimensional space where the coordinates designate the Gregorian year, month, day, hour, minute, and second components defined in Section 5.5.3.2 of [ISO 8601], respectively. These components are ordered in their significance by their order of appearance i.e. as year, month, day, hour, minute, and second.

All six values are set by computing their values from the specified milliseconds and are availabe using the get methods of the created Duration. The values conform to and are defined by:

• ISO 8601:2000(E) Section 5.5.3.2 Alternative format
• W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
• XMLGregorianCalendar Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation

The default start instance is defined by GregorianCalendar's use of the start of the epoch: i.e., Calendar.YEAR = 1970, Calendar.MONTH = Calendar.JANUARY, Calendar.DATE = 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month = Calendar.FEBRUARY so the result of Duration.getMonths() and Duration.getDays() can be influenced.

Returns: New Duration representing durationInMilliSeconds.
Parameters:
- durationInMilliSeconds - Duration in milliseconds to create.

  Obtain a new instance of a Duration specifying the Duration as its string representation, "PnYnMnDTnHnMnS", as defined in XML Schema 1.0 section 3.2.6.1.

 

Obtain a new instance of a Duration specifying the Duration as its string representation, "PnYnMnDTnHnMnS", as defined in XML Schema 1.0 section 3.2.6.1.

XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration as:

duration represents a duration of time. The value space of duration is a six-dimensional space where the coordinates designate the Gregorian year, month, day, hour, minute, and second components defined in Section 5.5.3.2 of [ISO 8601], respectively. These components are ordered in their significance by their order of appearance i.e. as year, month, day, hour, minute, and second.

All six values are set and availabe from the created Duration

The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

Returns: New Duration created from parsing the lexicalRepresentation.
Parameters:
- lexicalRepresentation - String representation of a Duration.
Throws:
- IllegalArgumentException - If lexicalRepresentation is not a valid representation of a Duration.
- UnsupportedOperationException - If implementation cannot support requested values.
- NullPointerException - if lexicalRepresentation is null.

  Create a Duration of type xdt:dayTimeDuration using the specified day, hour, minute and second as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

 

Create a Duration of type xdt:dayTimeDuration using the specified day, hour, minute and second as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

The datatype xdt:dayTimeDuration is a subtype of xs:duration whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes.

The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

A null value indicates that field is not set.

Returns: New Duration created with the specified day, hour, minute and second.
Parameters:
- isPositive - Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored.
- day - Day of Duration.
- hour - Hour of Duration.
- minute - Minute of Duration.
- second - Second of Duration.
Throws:
- IllegalArgumentException - If the values are not a valid representation of a Duration: if all the fields (day, hour, ...) are null or if any of the fields is negative.
- UnsupportedOperationException - If implementation cannot support requested values.

  Create a Duration of type xdt:dayTimeDuration using the specified day, hour, minute and second as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

 

Create a Duration of type xdt:dayTimeDuration using the specified day, hour, minute and second as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

The datatype xdt:dayTimeDuration is a subtype of xs:duration whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: New Duration created with the specified day, hour, minute and second.
Parameters:
- isPositive - Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored.
- day - Day of Duration.
- hour - Hour of Duration.
- minute - Minute of Duration.
- second - Second of Duration.
Throws:
- IllegalArgumentException - If the values are not a valid representation of a Duration: if any of the fields (day, hour, ...) is negative.

  Create a Duration of type xdt:dayTimeDuration using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

 

Create a Duration of type xdt:dayTimeDuration using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

The datatype xdt:dayTimeDuration is a subtype of xs:duration whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes.

All four values are set by computing their values from the specified milliseconds and are availabe using the get methods of the created Duration. The values conform to and are defined by:

• ISO 8601:2000(E) Section 5.5.3.2 Alternative format
• W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
• XMLGregorianCalendar Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation

The default start instance is defined by GregorianCalendar's use of the start of the epoch: i.e., Calendar.YEAR = 1970, Calendar.MONTH = Calendar.JANUARY, Calendar.DATE = 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month = Calendar.FEBRUARY so the result of Duration.getDays() can be influenced.

Any remaining milliseconds after determining the day, hour, minute and second are discarded.

Returns: New Duration created with the specified durationInMilliseconds.
Parameters:
- durationInMilliseconds - Milliseconds of Duration to create.
See Also: XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration,

  Create a Duration of type xdt:dayTimeDuration by parsing its String representation, "PnDTnHnMnS", XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

 

Create a Duration of type xdt:dayTimeDuration by parsing its String representation, "PnDTnHnMnS", XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.

The datatype xdt:dayTimeDuration is a subtype of xs:duration whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes.

All four values are set and availabe from the created Duration

The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

Returns: New Duration created using the specified lexicalRepresentation.
Parameters:
- lexicalRepresentation - Lexical representation of a duration.
Throws:
- IllegalArgumentException - If lexicalRepresentation is not a valid representation of a Duration expressed only in terms of days and time.
- UnsupportedOperationException - If implementation cannot support requested values.
- NullPointerException - If lexicalRepresentation is null.

  Create a Duration of type xdt:yearMonthDuration using the specified year and month as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

 

Create a Duration of type xdt:yearMonthDuration using the specified year and month as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

A null value indicates that field is not set.

Returns: New Duration created using the specified year and month.
Parameters:
- isPositive - Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored.
- year - Year of Duration.
- month - Month of Duration.
Throws:
- IllegalArgumentException - If the values are not a valid representation of a Duration: if all of the fields (year, month) are null or if any of the fields is negative.
- UnsupportedOperationException - If implementation cannot support requested values.

  Create a Duration of type xdt:yearMonthDuration using the specified year and month as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

 

Create a Duration of type xdt:yearMonthDuration using the specified year and month as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: New Duration created using the specified year and month.
Parameters:
- isPositive - Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored.
- year - Year of Duration.
- month - Month of Duration.
Throws:
- IllegalArgumentException - If the values are not a valid representation of a Duration: if any of the fields (year, month) is negative.

  Create a Duration of type xdt:yearMonthDuration using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

 

Create a Duration of type xdt:yearMonthDuration using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

The datatype xdt:yearMonthDuration is a subtype of xs:duration whose lexical representation contains only year and month components. This datatype resides in the namespace XMLConstants.W3C_XPATH_DATATYPE_NS_URI.

Both values are set by computing their values from the specified milliseconds and are availabe using the get methods of the created Duration. The values conform to and are defined by:

• ISO 8601:2000(E) Section 5.5.3.2 Alternative format
• W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
• XMLGregorianCalendar Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation

The default start instance is defined by GregorianCalendar's use of the start of the epoch: i.e., Calendar.YEAR = 1970, Calendar.MONTH = Calendar.JANUARY, Calendar.DATE = 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month = Calendar.FEBRUARY so the result of Duration.getMonths() can be influenced.

Any remaining milliseconds after determining the year and month are discarded.

Returns: New Duration created using the specified durationInMilliseconds.
Parameters:
- durationInMilliseconds - Milliseconds of Duration to create.

  Create a Duration of type xdt:yearMonthDuration by parsing its String representation, "PnYnM", XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

 

Create a Duration of type xdt:yearMonthDuration by parsing its String representation, "PnYnM", XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.

The datatype xdt:yearMonthDuration is a subtype of xs:duration whose lexical representation contains only year and month components. This datatype resides in the namespace XMLConstants.W3C_XPATH_DATATYPE_NS_URI.

Both values are set and availabe from the created Duration

The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

Returns: New Duration created using the specified lexicalRepresentation.
Parameters:
- lexicalRepresentation - Lexical representation of a duration.
Throws:
- IllegalArgumentException - If lexicalRepresentation is not a valid representation of a Duration expressed only in terms of years and months.
- UnsupportedOperationException - If implementation cannot support requested values.
- NullPointerException - If lexicalRepresentation is null.

  Obtain a new instance of a DatatypeFactory.

 

Obtain a new instance of a DatatypeFactory.

The implementation resolution mechanisms are defined in this Class's documentation.

Returns: New instance of a DatatypeFactory
Throws:
- DatatypeConfigurationException - If the implementation is not available or cannot be instantiated.
See Also: DatatypeFactory.newInstance(String factoryClassName, ClassLoader classLoader),

  Obtain a new instance of a DatatypeFactory from class name.

 

Obtain a new instance of a DatatypeFactory from class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded.

Once an application has obtained a reference to a DatatypeFactory it can use the factory to configure and obtain datatype instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems try:

 java -Djaxp.debug=1 YourProgram ....
 

Returns: New instance of a DatatypeFactory
Parameters:
- factoryClassName - fully qualified factory class name that provides implementation of javax.xml.datatype.DatatypeFactory.
- classLoader - ClassLoader used to load the factory class. If null current Thread's context classLoader is used to load the factory class.
Throws:
- DatatypeConfigurationException - if factoryClassName is null, or the factory class cannot be loaded, instantiated.
Since: 1.6
See Also: DatatypeFactory.newInstance(),

  Create a new instance of an XMLGregorianCalendar.

 

Create a new instance of an XMLGregorianCalendar.

All date/time datatype fields set to DatatypeConstants.FIELD_UNDEFINED or null.

Returns: New XMLGregorianCalendar with all date/time datatype fields set to {@link DatatypeConstants#FIELD_UNDEFINED} or null.

  Constructor allowing for complete value spaces allowed by W3C XML Schema 1.0 recommendation for xsd:dateTime and related builtin datatypes.

 

Constructor allowing for complete value spaces allowed by W3C XML Schema 1.0 recommendation for xsd:dateTime and related builtin datatypes. Note that year parameter supports arbitrarily large numbers and fractionalSecond has infinite precision.

A null value indicates that field is not set.

Returns: XMLGregorianCalendar created from specified values.
Parameters:
- year - of XMLGregorianCalendar to be created.
- month - of XMLGregorianCalendar to be created.
- day - of XMLGregorianCalendar to be created.
- hour - of XMLGregorianCalendar to be created.
- minute - of XMLGregorianCalendar to be created.
- second - of XMLGregorianCalendar to be created.
- fractionalSecond - of XMLGregorianCalendar to be created.
- timezone - of XMLGregorianCalendar to be created.
Throws:
- IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar} or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by {@link XMLGregorianCalendar#isValid()}.

  Create an XMLGregorianCalendar from a GregorianCalendar.

 

Create an XMLGregorianCalendar from a GregorianCalendar.

Field by Field Conversion from GregorianCalendar to an XMLGregorianCalendar
java.util.GregorianCalendar field	javax.xml.datatype.XMLGregorianCalendar field
ERA == GregorianCalendar.BC ? -YEAR : YEAR	XMLGregorianCalendar.setYear(int year)
MONTH + 1	XMLGregorianCalendar.setMonth(int month)
DAY_OF_MONTH	XMLGregorianCalendar.setDay(int day)
HOUR_OF_DAY, MINUTE, SECOND, MILLISECOND	XMLGregorianCalendar.setTime(int hour, int minute, int second, BigDecimal fractional)
(ZONE_OFFSET + DST_OFFSET) / (60*1000) (in minutes)	XMLGregorianCalendar.setTimezone(int offset)*

*conversion loss of information. It is not possible to represent a java.util.GregorianCalendar daylight savings timezone id in the XML Schema 1.0 date/time datatype representation.

To compute the return value's TimeZone field,

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

Returns: XMLGregorianCalendar created from java.util.GregorianCalendar
Parameters:
- cal - java.util.GregorianCalendar used to create XMLGregorianCalendar
Throws:
- NullPointerException - If cal is null.

  Constructor of value spaces that a java.util.GregorianCalendar instance would need to convert to an XMLGregorianCalendar instance.

 

Constructor of value spaces that a java.util.GregorianCalendar instance would need to convert to an XMLGregorianCalendar instance.

XMLGregorianCalendar eon and fractionalSecond are set to null

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: XMLGregorianCalendar created from specified values.
Parameters:
- year - of XMLGregorianCalendar to be created.
- month - of XMLGregorianCalendar to be created.
- day - of XMLGregorianCalendar to be created.
- hour - of XMLGregorianCalendar to be created.
- minute - of XMLGregorianCalendar to be created.
- second - of XMLGregorianCalendar to be created.
- millisecond - of XMLGregorianCalendar to be created.
- timezone - of XMLGregorianCalendar to be created.
Throws:
- IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar} or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by {@link XMLGregorianCalendar#isValid()}.

  Create a new XMLGregorianCalendar by parsing the String as a lexical representation.

 

Create a new XMLGregorianCalendar by parsing the String as a lexical representation.

Parsing the lexical string representation is defined in XML Schema 1.0 Part 2, Section 3.2.[7-14].1, Lexical Representation.

The string representation may not have any leading and trailing whitespaces.

The parsing is done field by field so that the following holds for any lexically correct String x:

 newXMLGregorianCalendar(x).toXMLFormat().equals(x)
 

Except for the noted lexical/canonical representation mismatches listed in XML Schema 1.0 errata, Section 3.2.7.2.

Returns: XMLGregorianCalendar created from the lexicalRepresentation.
Parameters:
- lexicalRepresentation - Lexical representation of one the eight XML Schema date/time datatypes.
Throws:
- IllegalArgumentException - If the lexicalRepresentation is not a valid XMLGregorianCalendar.
- NullPointerException - If lexicalRepresentation is null.

  Create a Java representation of XML Schema builtin datatype date or g*.

 

Create a Java representation of XML Schema builtin datatype date or g*.

For example, an instance of gYear can be created invoking this factory with month and day parameters set to DatatypeConstants.FIELD_UNDEFINED.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: XMLGregorianCalendar created from parameter values.
Parameters:
- year - of XMLGregorianCalendar to be created.
- month - of XMLGregorianCalendar to be created.
- day - of XMLGregorianCalendar to be created.
- timezone - offset in minutes. {@link DatatypeConstants#FIELD_UNDEFINED} indicates optional field is not set.
Throws:
- IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar} or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by {@link XMLGregorianCalendar#isValid()}.
See Also: DatatypeConstants.FIELD_UNDEFINED,

  Create a Java instance of XML Schema builtin datatype time.

 

Create a Java instance of XML Schema builtin datatype time.

A null value indicates that field is not set.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: XMLGregorianCalendar created from parameter values.
Parameters:
- hours - number of hours
- minutes - number of minutes
- seconds - number of seconds
- fractionalSecond - value of null indicates that this optional field is not set.
- timezone - offset in minutes. {@link DatatypeConstants#FIELD_UNDEFINED} indicates optional field is not set.
Throws:
- IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar} or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by {@link XMLGregorianCalendar#isValid()}.
See Also: DatatypeConstants.FIELD_UNDEFINED,

  Create a Java instance of XML Schema builtin datatype time.

 

Create a Java instance of XML Schema builtin datatype time.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: XMLGregorianCalendar created from parameter values.
Parameters:
- hours - number of hours
- minutes - number of minutes
- seconds - number of seconds
- timezone - offset in minutes. {@link DatatypeConstants#FIELD_UNDEFINED} indicates optional field is not set.
Throws:
- IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar} or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by {@link XMLGregorianCalendar#isValid()}.
See Also: DatatypeConstants.FIELD_UNDEFINED,

  Create a Java instance of XML Schema builtin datatype time.

 

Create a Java instance of XML Schema builtin datatype time.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Returns: XMLGregorianCalendar created from parameter values.
Parameters:
- hours - number of hours
- minutes - number of minutes
- seconds - number of seconds
- milliseconds - number of milliseconds
- timezone - offset in minutes. {@link DatatypeConstants#FIELD_UNDEFINED} indicates optional field is not set.
Throws:
- IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar} or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by {@link XMLGregorianCalendar#isValid()}.
See Also: DatatypeConstants.FIELD_UNDEFINED,