JAXP 1.4 Change Log

javax.xml.datatype
Class DatatypeConfigurationException

 java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.xml.datatype.DatatypeConfigurationException
 

public class DatatypeConfigurationException

extends java.lang.Exception

Indicates a serious configuration error.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

Serialized Form

javax.xml.datatype
Class DatatypeConfigurationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.xml.datatype.DatatypeConfigurationException

public class DatatypeConfigurationException

extends java.lang.Exception

Indicates a serious configuration error.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

Serialized Form

javax.xml.datatype
Class DatatypeConfigurationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.xml.datatype.DatatypeConfigurationException

public class DatatypeConfigurationException

extends java.lang.Exception

Indicates a serious configuration error.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

Serialized Form

javax.xml.datatype
Class DatatypeConstants.Field

 java.lang.Object
  javax.xml.datatype.DatatypeConstants.Field
 

public static final class DatatypeConstants.Field

extends java.lang.Object

Type-safe enum class that represents six fields of the Duration class.

Since:

1.5

javax.xml.datatype
Class DatatypeConstants.Field

java.lang.Object
  javax.xml.datatype.DatatypeConstants.Field

public static final class DatatypeConstants.Field

extends java.lang.Object

Type-safe enum class that represents six fields of the Duration class.

javax.xml.datatype
Class DatatypeConstants.Field

java.lang.Object
  javax.xml.datatype.DatatypeConstants.Field

public static final class DatatypeConstants.Field

extends java.lang.Object

Type-safe enum class that represents six fields of the Duration class.

Since:

1.5

javax.xml.datatype
Class DatatypeFactory

 java.lang.Object
  javax.xml.datatype.DatatypeFactory
 

public abstract class DatatypeFactory

extends java.lang.Object

Factory that creates new javax.xml.datatype Object s that map XML to/from Java Object s.

newInstance() newInstance() is used to create a new DatatypeFactory . The following implementation resolution mechanisms are used in the following order:

1. If the system property specified by DATATYPEFACTORY_PROPERTY , " javax.xml.datatype.DatatypeFactory ", exists, a class with the name of the property's value is instantiated. Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.
2. If the file ${JAVA_HOME}/lib/jaxp.properties exists, it is loaded in a Properties Object . The Properties Object is then queried for the property as documented in the prior step and processed as documented in the prior step.
3. The services resolution mechanism is used, e.g. META-INF/services/java.xml.datatype.DatatypeFactory . Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.
4. The final mechanism is to attempt to instantiate the Class specified by DATATYPEFACTORY_IMPLEMENTATION_CLASS . , " javax.xml.datatype.DatatypeFactoryImpl ". Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Joseph Fialli , Jeff Suttor , Neeraj Bajaj

javax.xml.datatype
Class DatatypeFactory

java.lang.Object
  javax.xml.datatype.DatatypeFactory

public abstract class DatatypeFactory

extends java.lang.Object

Factory that creates new javax.xml.datatype Objects that map XML to/from Java Objects.

newInstance() is used to create a new DatatypeFactory. The following implementation resolution mechanisms are used in the following order:

1. If the system property specified by DATATYPEFACTORY_PROPERTY, "javax.xml.datatype.DatatypeFactory", exists, a class with the name of the property's value is instantiated. Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.
2. If the file ${JAVA_HOME}/lib/jaxp.properties exists, it is loaded in a Properties Object. The Properties Object is then queried for the property as documented in the prior step and processed as documented in the prior step.
3. The services resolution mechanism is used, e.g. META-INF/services/java.xml.datatype.DatatypeFactory. Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.
4. The final mechanism is to attempt to instantiate the Class specified by DATATYPEFACTORY_IMPLEMENTATION_CLASS, "javax.xml.datatype.DatatypeFactoryImpl". Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Joseph Fialli, Jeff Suttor

javax.xml.datatype
Class DatatypeFactory

java.lang.Object
  javax.xml.datatype.DatatypeFactory

public abstract class DatatypeFactory

extends java.lang.Object

Factory that creates new javax.xml.datatype Objects that map XML to/from Java Objects.

newInstance() is used to create a new DatatypeFactory. The following implementation resolution mechanisms are used in the following order:

1. If the system property specified by DATATYPEFACTORY_PROPERTY, "javax.xml.datatype.DatatypeFactory", exists, a class with the name of the property's value is instantiated. Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.
2. If the file ${JAVA_HOME}/lib/jaxp.properties exists, it is loaded in a Properties Object. The Properties Object is then queried for the property as documented in the prior step and processed as documented in the prior step.
3. The services resolution mechanism is used, e.g. META-INF/services/java.xml.datatype.DatatypeFactory. Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.
4. The final mechanism is to attempt to instantiate the Class specified by DATATYPEFACTORY_IMPLEMENTATION_CLASS. Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Joseph Fialli, Jeff Suttor, Neeraj Bajaj

 public static final java.lang.String DATATYPEFACTORY_IMPLEMENTATION_CLASS

Default implementation class name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1.3 . 1.3.

Implementers should specify the name of an appropriate class to be instantiated if no other implementation resolution mechanism succeeds. Default value is com.sun.org.apache.xerces.internal.jaxp.datatype.DatatypeFactoryImpl.

Users should not refer to this field; it is intended only to document a factory implementation detail.

See Also:

Constant Field Values

public static final java.lang.String DATATYPEFACTORY_IMPLEMENTATION_CLASS

Default implementation class name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1.3.

Default value is com.sun.org.apache.xerces.internal.jaxp.datatype.DatatypeFactoryImpl.

See Also:

Constant Field Values

 public Duration newDuration(boolean isPositive,
                            int years,
                            int months,
                            int days,
                            int hours,
                            int minutes,
                            int 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 isnot set.

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

Returns:

New Duration created from the specified values.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a Duration : if any of the fields is negative. .

See Also:

newDuration( boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds)

public Duration newDuration(boolean isPositive,
                            int years,
                            int months,
                            int days,
                            int hours,
                            int minutes,
                            int 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 isnot set.

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

Returns:

New Duration created from the specified values.

Throws:

java.lang.IllegalArgumentException - If values are not a valid representation of a Duration.

See Also:

newDuration( boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds)

public Duration newDuration(boolean isPositive,
                            int years,
                            int months,
                            int days,
                            int hours,
                            int minutes,
                            int 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.

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

Returns:

New Duration created from the specified values.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a Duration: if any of the fields is negative.

See Also:

newDuration( boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds)

 public abstract Duration newDuration(boolean isPositive,
                                     java.math.BigInteger years,
                                     java.math.BigInteger months,
                                     java.math.BigInteger days,
                                     java.math.BigInteger hours,
                                     java.math.BigInteger minutes,
                                     java.math.BigDecimal 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 isnot set.

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

Returns:

New Duration created from the specified values.

Throws:

java.lang.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. .

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

public abstract Duration newDuration(boolean isPositive,
                                     java.math.BigInteger years,
                                     java.math.BigInteger months,
                                     java.math.BigInteger days,
                                     java.math.BigInteger hours,
                                     java.math.BigInteger minutes,
                                     java.math.BigDecimal 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 isnot set.

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

Returns:

New Duration created from the specified values.

Throws:

java.lang.IllegalArgumentException - If values are not a valid representation of a Duration.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

public abstract Duration newDuration(boolean isPositive,
                                     java.math.BigInteger years,
                                     java.math.BigInteger months,
                                     java.math.BigInteger days,
                                     java.math.BigInteger hours,
                                     java.math.BigInteger minutes,
                                     java.math.BigDecimal 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.

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

Returns:

New Duration created from the specified values.

Throws:

java.lang.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.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

 public Duration newDurationDayTime(boolean isPositive,
                                   int day,
                                   int hour,
                                   int minute,
                                   int second)

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 isnot set.

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.

Returns:

New Duration created with the specified day , hour , minute and second.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a - If any values would create an invalid Duration : if any of the fields (day, hour, ...) is negative. .

public Duration newDurationDayTime(boolean isPositive,
                                   int day,
                                   int hour,
                                   int minute,
                                   int second)

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 isnot set.

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.

Returns:

New Duration created with the specified day, hour, minute and second.

Throws:

java.lang.IllegalArgumentException - If any values would create an invalid Duration.

public Duration newDurationDayTime(boolean isPositive,
                                   int day,
                                   int hour,
                                   int minute,
                                   int second)

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.

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.

Returns:

New Duration created with the specified day, hour, minute and second.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a Duration: if any of the fields (day, hour, ...) is negative.

 public Duration newDurationDayTime(boolean isPositive,
                                   java.math.BigInteger day,
                                   java.math.BigInteger hour,
                                   java.math.BigInteger minute,
                                   java.math.BigInteger second)

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 isnot set.

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.

Returns:

New Duration created with the specified day , hour , minute and second.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a - If any values would create an invalid Duration : if all the fields (day, hour, ...) are null or if any of the fields is negative. .

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

public Duration newDurationDayTime(boolean isPositive,
                                   java.math.BigInteger day,
                                   java.math.BigInteger hour,
                                   java.math.BigInteger minute,
                                   java.math.BigInteger second)

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 isnot set.

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.

Returns:

New Duration created with the specified day, hour, minute and second.

Throws:

java.lang.IllegalArgumentException - If any values would create an invalid Duration.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

public Duration newDurationDayTime(boolean isPositive,
                                   java.math.BigInteger day,
                                   java.math.BigInteger hour,
                                   java.math.BigInteger minute,
                                   java.math.BigInteger second)

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.

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.

Returns:

New Duration created with the specified day, hour, minute and second.

Throws:

java.lang.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.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

 public Duration newDurationDayTime(java.lang.String lexicalRepresentation)

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.

Parameters:

lexicalRepresentation - Lexical representation of a duration.

Returns:

New Duration created using the specified lexicalRepresentation.

Throws:

java.lang.IllegalArgumentException - If lexicalRepresentation is not a valid representation of a Duration expressed only in terms of days and time. - If the given string does not conform to the aforementioned specification.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

java.lang.NullPointerException - If lexicalRepresentation is null.

public Duration newDurationDayTime(java.lang.String lexicalRepresentation)

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.

Parameters:

lexicalRepresentation - Lexical representation of a duration.

Returns:

New Duration created using the specified lexicalRepresentation.

Throws:

java.lang.IllegalArgumentException - If the given string does not conform to the aforementioned specification.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

java.lang.NullPointerException - If lexicalRepresentation is null.

public Duration newDurationDayTime(java.lang.String lexicalRepresentation)

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.

Parameters:

lexicalRepresentation - Lexical representation of a duration.

Returns:

New Duration created using the specified lexicalRepresentation.

Throws:

java.lang.IllegalArgumentException - If lexicalRepresentation is not a valid representation of a Duration expressed only in terms of days and time.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

java.lang.NullPointerException - If lexicalRepresentation is null.

 public Duration newDurationYearMonth(boolean isPositive,
                                     int year,
                                     int month)

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 isnot set.

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.

Returns:

New Duration created using the specified year and month.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a - If any values would create an invalid Duration : if any of the fields (year, month) is negative. .

public Duration newDurationYearMonth(boolean isPositive,
                                     int year,
                                     int month)

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 isnot set.

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.

Returns:

New Duration created using the specified year and month.

Throws:

java.lang.IllegalArgumentException - If any values would create an invalid Duration.

public Duration newDurationYearMonth(boolean isPositive,
                                     int year,
                                     int month)

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.

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.

Returns:

New Duration created using the specified year and month.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a Duration: if any of the fields (year, month) is negative.

 public Duration newDurationYearMonth(boolean isPositive,
                                     java.math.BigInteger year,
                                     java.math.BigInteger month)

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 isnot set.

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.

Returns:

New Duration created using the specified year and month.

Throws:

java.lang.IllegalArgumentException - If the values are not a valid representation of a - If any values would create an invalid Duration : if all of the fields (year, month) are null or if any of the fields is negative. .

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

public Duration newDurationYearMonth(boolean isPositive,
                                     java.math.BigInteger year,
                                     java.math.BigInteger month)

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 isnot set.

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.

Returns:

New Duration created using the specified year and month.

Throws:

java.lang.IllegalArgumentException - If any values would create an invalid Duration.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

public Duration newDurationYearMonth(boolean isPositive,
                                     java.math.BigInteger year,
                                     java.math.BigInteger month)

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.

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.

Returns:

New Duration created using the specified year and month.

Throws:

java.lang.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.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

 public Duration newDurationYearMonth(java.lang.String lexicalRepresentation)

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.

Parameters:

lexicalRepresentation - Lexical representation of a duration.

Returns:

New Duration created using the specified lexicalRepresentation.

Throws:

java.lang.IllegalArgumentException - If the lexicalRepresentation is not a valid representation of a Duration expressed only in terms of years and months. does not conform to the specification.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

java.lang.NullPointerException - If lexicalRepresentation is null.

public Duration newDurationYearMonth(java.lang.String lexicalRepresentation)

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.

Parameters:

lexicalRepresentation - Lexical representation of a duration.

Returns:

New Duration created using the specified lexicalRepresentation.

Throws:

java.lang.IllegalArgumentException - If the lexicalRepresentation does not conform to the specification.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

java.lang.NullPointerException - If lexicalRepresentation is null.

public Duration newDurationYearMonth(java.lang.String lexicalRepresentation)

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.

Parameters:

lexicalRepresentation - Lexical representation of a duration.

Returns:

New Duration created using the specified lexicalRepresentation.

Throws:

java.lang.IllegalArgumentException - If lexicalRepresentation is not a valid representation of a Duration expressed only in terms of years and months.

java.lang.UnsupportedOperationException - If implementation cannot support requested values.

java.lang.NullPointerException - If lexicalRepresentation is null.

 public static DatatypeFactory newInstance()
                                   throws DatatypeConfigurationException

Obtain a new instance of a DatatypeFactory.

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

Returns:

New instance of a DatatypeFactory DocumentBuilderFactory

Throws:

DatatypeConfigurationException - If the implementation is not available or cannot be instantiated.

See Also:

newInstance(String factoryClassName, ClassLoader classLoader)

public static DatatypeFactory newInstance()
                                   throws DatatypeConfigurationException

Obtain a new instance of a DatatypeFactory.

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

Returns:

New instance of a DocumentBuilderFactory

Throws:

DatatypeConfigurationException - If the implementation is not available or cannot be instantiated.

public static DatatypeFactory newInstance()
                                   throws DatatypeConfigurationException

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:

newInstance(String factoryClassName, ClassLoader classLoader)

public static DatatypeFactory newInstance(java.lang.String factoryClassName,
                                          java.lang.ClassLoader classLoader)
                                   throws DatatypeConfigurationException

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 ....
 

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.

Returns:

New instance of a DatatypeFactory

Throws:

DatatypeConfigurationException - if factoryClassName is null, or the factory class cannot be loaded, instantiated.

Since:

1.6

See Also:

newInstance()

 public XMLGregorianCalendar newXMLGregorianCalendar(int year,
                                                    int month,
                                                    int day,
                                                    int hour,
                                                    int minute,
                                                    int second,
                                                    int millisecond,
                                                    int timezone)

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 isnot set.

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.

Returns:

XMLGregorianCalendar created from specified values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

public XMLGregorianCalendar newXMLGregorianCalendar(int year,
                                                    int month,
                                                    int day,
                                                    int hour,
                                                    int minute,
                                                    int second,
                                                    int millisecond,
                                                    int timezone)

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 isnot set.

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.

Returns:

XMLGregorianCalendar created from specified values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

public XMLGregorianCalendar newXMLGregorianCalendar(int year,
                                                    int month,
                                                    int day,
                                                    int hour,
                                                    int minute,
                                                    int second,
                                                    int millisecond,
                                                    int timezone)

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.

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.

Returns:

XMLGregorianCalendar created from specified values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

 public abstract XMLGregorianCalendar newXMLGregorianCalendar(java.math.BigInteger year,
                                                             int month,
                                                             int day,
                                                             int hour,
                                                             int minute,
                                                             int second,
                                                             java.math.BigDecimal fractionalSecond,
                                                             int timezone)

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 isnot set.

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.

Returns:

XMLGregorianCalendar created from specified values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

public abstract XMLGregorianCalendar newXMLGregorianCalendar(java.math.BigInteger year,
                                                             int month,
                                                             int day,
                                                             int hour,
                                                             int minute,
                                                             int second,
                                                             java.math.BigDecimal fractionalSecond,
                                                             int timezone)

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 isnot set.

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.

Returns:

XMLGregorianCalendar created from specified values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

public abstract XMLGregorianCalendar newXMLGregorianCalendar(java.math.BigInteger year,
                                                             int month,
                                                             int day,
                                                             int hour,
                                                             int minute,
                                                             int second,
                                                             java.math.BigDecimal fractionalSecond,
                                                             int timezone)

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.

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.

Returns:

XMLGregorianCalendar created from specified values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

 public XMLGregorianCalendar newXMLGregorianCalendarDate(int year,
                                                        int month,
                                                        int day,
                                                        int timezone)

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 isnot set.

Parameters:

year - of XMLGregorianCalendar to be created.

month - of XMLGregorianCalendar to be created.

day - of XMLGregorianCalendar to be created.

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarDate(int year,
                                                        int month,
                                                        int day,
                                                        int timezone)

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 isnot set.

Parameters:

year - of XMLGregorianCalendar to be created.

month - of XMLGregorianCalendar to be created.

day - of XMLGregorianCalendar to be created.

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarDate(int year,
                                                        int month,
                                                        int day,
                                                        int timezone)

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.

Parameters:

year - of XMLGregorianCalendar to be created.

month - of XMLGregorianCalendar to be created.

day - of XMLGregorianCalendar to be created.

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

 public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

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

Parameters:

hours - number of hours

minutes - number of minutes

seconds - number of seconds

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field isnot set.

Parameters:

hours - number of hours

minutes - number of minutes

seconds - number of seconds

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

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

Parameters:

hours - number of hours

minutes - number of minutes

seconds - number of seconds

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

 public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        int milliseconds,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

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

Parameters:

hours - number of hours

minutes - number of minutes

seconds - number of seconds

milliseconds - number of milliseconds

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        int milliseconds,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field isnot set.

Parameters:

hours - number of hours

minutes - number of minutes

seconds - number of seconds

milliseconds - number of milliseconds

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        int milliseconds,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

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

Parameters:

hours - number of hours

minutes - number of minutes

seconds - number of seconds

milliseconds - number of milliseconds

timezone - offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

 public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        java.math.BigDecimal fractionalSecond,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

A null value indicates that field is not isnot set.

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

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. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        java.math.BigDecimal fractionalSecond,
                                                        int timezone)

Create a Java instance of XML Schema builtin datatype time.

A null value indicates that field isnot set.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field isnot set.

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. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours,
                                                        int minutes,
                                                        int seconds,
                                                        java.math.BigDecimal fractionalSecond,
                                                        int timezone)

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.

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. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

java.lang.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 XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

javax.xml.datatype
Class Duration

 java.lang.Object
  javax.xml.datatype.Duration
 

public abstract class Duration

extends java.lang.Object

Immutable representation of a time span as defined in the W3C XML Schema 1.0 specification.

A Duration object represents a period of Gregorian time, which consists of six fields (years, months, days, hours, minutes, and seconds) plus a sign (+/-) field.

The first five fields have non-negative (>=0) integers or null (which represents that the field is not set), and the seconds field has a non-negative decimal or null. A negative sign indicates a negative duration.

This class provides a number of methods that make it easy to use for the duration datatype of XML Schema 1.0 with the errata.

Order relationship

Duration objects only have partial order, where two values A and B maybe either:

1. A<B (A is shorter than B)
2. A>B (A is longer than B)
3. A==B (A and B are of the same duration)
4. A<>B (Comparison between A and B is indeterminate)

For example, 30 days cannot be meaningfully compared to one month. The compare(Duration duration) method implements this relationship.

See the isLongerThan(Duration) method for details about the order relationship among Duration objects.

Operations over Duration

This class provides a set of basic arithmetic operations, such as addition, subtraction and multiplication. Because durations don't have total order, an operation could fail for some combinations of operations. For example, you cannot subtract 15 days from 1 month. See the javadoc of those methods for detailed conditions where this could happen.

Also, division of a duration by a number is not provided because the Duration class can only deal with finite precision decimal numbers. For example, one cannot represent 1 sec divided by 3.

However, you could substitute a division by 3 with multiplying by numbers such as 0.3 or 0.333.

Range of allowed values

Because some operations of Duration rely on Calendar even though Duration can hold very large or very small values, some of the methods may not work correctly on such Duration s. The impacted methods document their dependency on Calendar .

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Joseph Fialli , Kohsuke Kawaguchi , Jeff Suttor , Sunitha Reddy

See Also:

XMLGregorianCalendar.add(Duration)

javax.xml.datatype
Class Duration

java.lang.Object
  javax.xml.datatype.Duration

public abstract class Duration

extends java.lang.Object

Immutable representation of a time span as defined in the W3C XML Schema 1.0 specification.

A Duration object represents a period of Gregorian time, which consists of six fields (years, months, days, hours, minutes, and seconds) plus a sign (+/-) field.

The first five fields have non-negative (>=0) integers or null (which represents that the field is not set), and the seconds field has a non-negative decimal or null. A negative sign indicates a negative duration.

This class provides a number of methods that make it easy to use for the duration datatype of XML Schema 1.0 with the errata.

Order relationship

Duration objects only have partial order, where two values A and B maybe either:

1. A<B (A is shorter than B)
2. A>B (A is longer than B)
3. A==B (A and B are of the same duration)
4. A<>B (Comparison between A and B is indeterminate)

For example, 30 days cannot be meaningfully compared to one month. The compare(Duration duration) method implements this relationship.

See the isLongerThan(Duration) method for details about the order relationship among Duration objects.

Operations over Duration

This class provides a set of basic arithmetic operations, such as addition, subtraction and multiplication. Because durations don't have total order, an operation could fail for some combinations of operations. For example, you cannot subtract 15 days from 1 month. See the javadoc of those methods for detailed conditions where this could happen.

Also, division of a duration by a number is not provided because the Duration class can only deal with finite precision decimal numbers. For example, one cannot represent 1 sec divided by 3.

However, you could substitute a division by 3 with multiplying by numbers such as 0.3 or 0.333.

Range of allowed values

Because some operations of Duration rely on Calendar even though Duration can hold very large or very small values, some of the methods may not work correctly on such Durations. The impacted methods document their dependency on Calendar.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Joseph Fialli, Kohsuke Kawaguchi, Jeff Suttor

See Also:

XMLGregorianCalendar.add(Duration)

javax.xml.datatype
Class Duration

java.lang.Object
  javax.xml.datatype.Duration

public abstract class Duration

extends java.lang.Object

Immutable representation of a time span as defined in the W3C XML Schema 1.0 specification.

A Duration object represents a period of Gregorian time, which consists of six fields (years, months, days, hours, minutes, and seconds) plus a sign (+/-) field.

The first five fields have non-negative (>=0) integers or null (which represents that the field is not set), and the seconds field has a non-negative decimal or null. A negative sign indicates a negative duration.

This class provides a number of methods that make it easy to use for the duration datatype of XML Schema 1.0 with the errata.

Order relationship

Duration objects only have partial order, where two values A and B maybe either:

1. A<B (A is shorter than B)
2. A>B (A is longer than B)
3. A==B (A and B are of the same duration)
4. A<>B (Comparison between A and B is indeterminate)

For example, 30 days cannot be meaningfully compared to one month. The compare(Duration duration) method implements this relationship.

See the isLongerThan(Duration) method for details about the order relationship among Duration objects.

Operations over Duration

This class provides a set of basic arithmetic operations, such as addition, subtraction and multiplication. Because durations don't have total order, an operation could fail for some combinations of operations. For example, you cannot subtract 15 days from 1 month. See the javadoc of those methods for detailed conditions where this could happen.

Also, division of a duration by a number is not provided because the Duration class can only deal with finite precision decimal numbers. For example, one cannot represent 1 sec divided by 3.

However, you could substitute a division by 3 with multiplying by numbers such as 0.3 or 0.333.

Range of allowed values

Because some operations of Duration rely on Calendar even though Duration can hold very large or very small values, some of the methods may not work correctly on such Durations. The impacted methods document their dependency on Calendar.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Joseph Fialli, Kohsuke Kawaguchi, Jeff Suttor, Sunitha Reddy

See Also:

XMLGregorianCalendar.add(Duration)

 public Duration()

Default no-arg constructor.

Note: Always use the DatatypeFactory to construct an instance of Duration. The constructor on this class cannot be guaranteed to produce an object with a consistent state and may be removed in the future.

public Duration()

Default no-arg constructor.

Note: Always use the DatatypeFactory to construct an instance of Duration. The constructor on this class cannot be guaranteed to produce an object with a consistent state and may be removed in the future.

 public boolean equals(java.lang.Object duration)

Checks if this duration object has the same duration as another Duration object.

For example, "P1D" (1 day) is equal to "PT24H" (24 hours).

Duration X is equal to Y if and only if time instant t+X and t+Y are the same for all the test time instants specified in the section 3.2.6.2 of the XML Schema 1.0 specification.

Note that there are cases where two Duration s are "incomparable" to each other, like one month and 30 days. For example,

 !new Duration("P1M").isShorterThan(new Duration("P30D"))
 !new Duration("P1M").isLongerThan(new Duration("P30D"))
 !new Duration("P1M").equals(new Duration("P30D"))
 

Overrides:

equals in class java.lang.Object

Parameters:

duration - The object to compare this - A non-null valid Duration against. object.

Returns:

true if this duration is the same length as duration. false if duration is not a null , is not a Duration object, object or its length is different from this duration.

Throws:

java.lang.UnsupportedOperationException - If the underlying implementation cannot reasonably process the request, e.g. W3C XML Schema allows for arbitrarily large/small/precise values, the request may be beyond the implementations capability.

java.lang.NullPointerException - if parameter is null.

See Also:

compare(Duration duration)

public boolean equals(java.lang.Object duration)

Checks if this duration object has the same duration as another Duration object.

For example, "P1D" (1 day) is equal to "PT24H" (24 hours).

Duration X is equal to Y if and only if time instant t+X and t+Y are the same for all the test time instants specified in the section 3.2.6.2 of the XML Schema 1.0 specification.

Note that there are cases where two Durations are "incomparable" to each other, like one month and 30 days. For example,

 !new Duration("P1M").isShorterThan(new Duration("P30D"))
 !new Duration("P1M").isLongerThan(new Duration("P30D"))
 !new Duration("P1M").equals(new Duration("P30D"))
 

Overrides:

equals in class java.lang.Object

Parameters:

duration - A non-null valid Duration object.

Returns:

true if this duration is the same length as duration. false if duration is not a Duration object or its length is different from this duration.

Throws:

java.lang.UnsupportedOperationException - If the underlying implementation cannot reasonably process the request, e.g. W3C XML Schema allows for arbitrarily large/small/precise values, the request may be beyond the implementations capability.

java.lang.NullPointerException - if parameter is null.

See Also:

compare(Duration duration)

public boolean equals(java.lang.Object duration)

Checks if this duration object has the same duration as another Duration object.

For example, "P1D" (1 day) is equal to "PT24H" (24 hours).

Duration X is equal to Y if and only if time instant t+X and t+Y are the same for all the test time instants specified in the section 3.2.6.2 of the XML Schema 1.0 specification.

Note that there are cases where two Durations are "incomparable" to each other, like one month and 30 days. For example,

 !new Duration("P1M").isShorterThan(new Duration("P30D"))
 !new Duration("P1M").isLongerThan(new Duration("P30D"))
 !new Duration("P1M").equals(new Duration("P30D"))
 

Overrides:

equals in class java.lang.Object

Parameters:

duration - The object to compare this Duration against.

Returns:

true if this duration is the same length as duration. false if duration is null, is not a Duration object, or its length is different from this duration.

Throws:

java.lang.UnsupportedOperationException - If the underlying implementation cannot reasonably process the request, e.g. W3C XML Schema allows for arbitrarily large/small/precise values, the request may be beyond the implementations capability.

See Also:

compare(Duration duration)

javax.xml.datatype
Class XMLGregorianCalendar

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

public abstract class XMLGregorianCalendar

extends java.lang.Object

implements java.lang.Cloneable

Representation for W3C XML Schema 1.0 date/time datatypes. Specifically, these date/time datatypes are DatatypeConstants.DATETIME dateTime , DatatypeConstants.TIME time , DatatypeConstants.DATE date , DatatypeConstants.GYEARMONTH gYearMonth , DatatypeConstants.GMONTHDAY gMonthDay , DatatypeConstants.GYEAR gYear , DatatypeConstants.GMONTH gMonth , and DatatypeConstants.GDAYand gDay defined in the XML Namespace "http://www.w3.org/2001/XMLSchema" . These datatypes are normatively defined in W3C XML Schema 1.0 Part 2, Section 3.2.7-14.

The table below defines the mapping between XML Schema 1.0 date/time datatype fields and this class' fields. It also summarizes the value constraints for the date and time fields defined in W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats.

• accessors/mutators for independent date/time fields
• conversion between this class and W3C XML Schema 1.0 lexical representation, toString() , DatatypeFactory.newXMLGregorianCalendar(String lexicalRepresentation)
• conversion between this class and GregorianCalendar , toGregorianCalendar(java.util.TimeZone timezone, java.util.Locale aLocale, XMLGregorianCalendar defaults) , DatatypeFactory
• partial order relation comparator method, compare(XMLGregorianCalendar xmlGregorianCalendar)
• equals(Object) defined relative to compare(XMLGregorianCalendar xmlGregorianCalendar).
• addition operation with Duration instance as defined in W3C XML Schema 1.0 Part 2, Appendix E, Adding durations to dateTimes.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Joseph Fialli , Kohsuke Kawaguchi , Jeff Suttor , Sunitha Reddy

See Also:

Duration , DatatypeFactory

javax.xml.datatype
Class XMLGregorianCalendar

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

public abstract class XMLGregorianCalendar

extends java.lang.Object

implements java.lang.Cloneable

Representation for W3C XML Schema 1.0 date/time datatypes. Specifically, these date/time datatypes are dateTime, time, date, gYearMonth, gMonthDay, gYear gMonth and gDay defined in the XML Namespace "http://www.w3.org/2001/XMLSchema". These datatypes are normatively defined in W3C XML Schema 1.0 Part 2, Section 3.2.7-14.

The table below defines the mapping between XML Schema 1.0 date/time datatype fields and this class' fields. It also summarizes the value constraints for the date and time fields defined in W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats.

 public XMLGregorianCalendar()

Default no-arg constructor.

Note: Always use the DatatypeFactory to construct an instance of XMLGregorianCalendar. The constructor on this class cannot be guaranteed to produce an object with a consistent state and may be removed in the future.

public XMLGregorianCalendar()

Default no-arg constructor.

Note: Always use the DatatypeFactory to construct an instance of XMLGregorianCalendar. The constructor on this class cannot be guaranteed to produce an object with a consistent state and may be removed in the future.

 public abstract void add(Duration duration)

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 date/time field mapping table defines the mapping from XML Schema 1.0 dateTime fields to this class' representation of those fields.

Parameters:

duration - Duration to add to this XMLGregorianCalendar.

Throws:

java.lang.NullPointerException - when duration parameter is null.

public abstract void add(Duration duration)

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.

Parameters:

duration - Duration to add to this XMLGregorianCalendar.

Throws:

java.lang.NullPointerException - when duration parameter is null.

public abstract void add(Duration duration)

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.

Parameters:

duration - Duration to add to this XMLGregorianCalendar.

Throws:

java.lang.NullPointerException - when duration parameter is null.

 public boolean equals(java.lang.Object obj)

Compares this calendar to the specified object. The result is Indicates whether parameter true obj if and only if the argument is not null and is an XMLGregorianCalendar object that represents the same instant in time as this object. is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

obj - to compare.

Returns:

true when obj is an instance of XMLGregorianCalendar and compare(XMLGregorianCalendar obj) returns DatatypeConstants.EQUAL , otherwise false.

Throws:

java.lang.NullPointerException - If obj is null.

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

Parameters:

obj - to compare.

Returns:

true when obj is an instance of XMLGregorianCalendar and compare(XMLGregorianCalendar obj) returns DatatypeConstants.EQUAL, otherwise false.

Throws:

java.lang.NullPointerException - If obj is null.

public boolean equals(java.lang.Object obj)

Compares this calendar to the specified object. The result is true if and only if the argument is not null and is an XMLGregorianCalendar object that represents the same instant in time as this object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - to compare.

Returns:

true when obj is an instance of XMLGregorianCalendar and compare(XMLGregorianCalendar obj) returns DatatypeConstants.EQUAL, otherwise false.

 public abstract void setFractionalSecond(java.math.BigDecimal fractional)

Set fractional seconds.

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

Parameters:

fractional - value constraints summarized in second field of date/time field mapping table fractional field of date/time field mapping table.

Throws:

java.lang.IllegalArgumentException - if fractional parameter is outside value constraints for the field as specified in date/time field mapping table.

public abstract void setFractionalSecond(java.math.BigDecimal fractional)

Set fractional seconds.

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

Parameters:

fractional - value constraints summarized in fractional field of date/time field mapping table.

Throws:

java.lang.IllegalArgumentException - if fractional parameter is outside value constraints for the field as specified in date/time field mapping table.

public abstract void setFractionalSecond(java.math.BigDecimal fractional)

Set fractional seconds.

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

Parameters:

fractional - value constraints summarized in second field of date/time field mapping table.

Throws:

java.lang.IllegalArgumentException - if fractional parameter is outside value constraints for the field as specified in date/time field mapping table.

 public abstract void setMillisecond(int millisecond)

Set milliseconds.

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

Parameters:

millisecond - value constraints summarized in second field of date/time field mapping table millisecond field of date/time field mapping table.

Throws:

java.lang.IllegalArgumentException - if millisecond parameter is outside value constraints for the field as specified in date/time field mapping table.

public abstract void setMillisecond(int millisecond)

Set milliseconds.

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

Parameters:

millisecond - value constraints summarized in millisecond field of date/time field mapping table.

Throws:

java.lang.IllegalArgumentException - if millisecond parameter is outside value constraints for the field as specified in date/time field mapping table.

public abstract void setMillisecond(int millisecond)

Set milliseconds.

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

Parameters:

millisecond - value constraints summarized in second field of date/time field mapping table.

Throws:

java.lang.IllegalArgumentException - if millisecond parameter is outside value constraints for the field as specified in date/time field mapping table.

 public abstract java.util.GregorianCalendar toGregorianCalendar()

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(TimeZone, Locale, XMLGregorianCalendar).

Field by Field Conversion from this class to java.util.GregorianCalendar
java.util.GregorianCalendar field	javax.xml.datatype.XMLGregorianCalendar field
ERA	getEonAndYear() .signum() <0 ? GregorianCalendar.BC : GregorianCalendar.AD
YEAR	getEonAndYear() .abs().intValue() *
MONTH	getMonth() - DatatypeConstants.JANUARY + Calendar.JANUARY
DAY_OF_MONTH	getDay()
HOUR_OF_DAY	getHour()
MINUTE	getMinute()
SECOND	getSecond()
MILLISECOND	get millisecond order from getFractionalSecond() *
GregorianCalendar.setTimeZone(TimeZone)	getTimezone() formatted into Custom timezone id

* designates possible loss of precision during the conversion due to source datatype having higher precision than target datatype.

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 Calendar.clear(). {(@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)

See Also:

toGregorianCalendar(java.util.TimeZone, java.util.Locale, XMLGregorianCalendar)

public abstract java.util.GregorianCalendar toGregorianCalendar()

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(TimeZone, Locale, XMLGregorianCalendar).

Field by Field Conversion from this class to java.util.GregorianCalendar
java.util.GregorianCalendar field	javax.xml.datatype.XMLGregorianCalendar field
ERA	getEonAndYear().signum() <0 ? GregorianCalendar.BC : GregorianCalendar.AD
YEAR	getEonAndYear().abs().intValue()*
MONTH	getMonth() - DatatypeConstants.JANUARY + Calendar.JANUARY
DAY_OF_MONTH	getDay()
HOUR_OF_DAY	getHour()
MINUTE	getMinute()
SECOND	getSecond()
MILLISECOND	get millisecond order from getFractionalSecond()*
GregorianCalendar.setTimeZone(TimeZone)	getTimezone() formatted into Custom timezone id

* designates possible loss of precision during the conversion due to source datatype having higher precision than target datatype.

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)

See Also:

toGregorianCalendar(java.util.TimeZone, java.util.Locale, XMLGregorianCalendar)

public abstract java.util.GregorianCalendar toGregorianCalendar()

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(TimeZone, Locale, XMLGregorianCalendar).

Field by Field Conversion from this class to java.util.GregorianCalendar
java.util.GregorianCalendar field	javax.xml.datatype.XMLGregorianCalendar field
ERA	getEonAndYear().signum() <0 ? GregorianCalendar.BC : GregorianCalendar.AD
YEAR	getEonAndYear().abs().intValue()*
MONTH	getMonth() - DatatypeConstants.JANUARY + Calendar.JANUARY
DAY_OF_MONTH	getDay()
HOUR_OF_DAY	getHour()
MINUTE	getMinute()
SECOND	getSecond()
MILLISECOND	get millisecond order from getFractionalSecond()*
GregorianCalendar.setTimeZone(TimeZone)	getTimezone() formatted into Custom timezone id

* designates possible loss of precision during the conversion due to source datatype having higher precision than target datatype.

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 Calendar.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)

See Also:

toGregorianCalendar(java.util.TimeZone, java.util.Locale, XMLGregorianCalendar)

javax.xml.namespace
Interface NamespaceContext

public interface NamespaceContext

Interface for read only XML Namespace context processing.

An XML Namespace has the properties:

• Namespace URI: Namespace name expressed as a URI to which the prefix is bound
• prefix: syntactically, this is the part of the attribute name following the XMLConstants.XMLNS_ATTRIBUTE ("xmlns") in the Namespace declaration

example: <element xmlns:prefix="http://Namespace-name-URI">

All get*(*) methods operate in the current scope for Namespace URI and prefix resolution.

Note that a Namespace URI can be bound to multiple prefixes in the current scope. This can occur when multiple XMLConstants.XMLNS_ATTRIBUTE ("xmlns") Namespace declarations occur in the same Start-Tag and refer to the same Namespace URI. e.g.

 <element xmlns:prefix1="http://Namespace-name-URI"
          xmlns:prefix2="http://Namespace-name-URI">
 

 <parent xmlns:prefix1="http://Namespace-name-URI">
   <child xmlns:prefix2="http://Namespace-name-URI">
     ...
   </child>
 </parent>
 

A prefix can only be bound to a single Namespace URI in the current scope.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

javax.xml.XMLConstants for declarations of common XML values javax.XMLConstants for declarations of common XML values , XML Schema Part2: Datatypes XML Schema Part2: Datatypes , Namespaces in XML Namespaces in XML , Namespaces in XML Errata Namespaces in XML Errata

javax.xml.namespace
Interface NamespaceContext

public interface NamespaceContext

Interface for read only XML Namespace context processing.

An XML Namespace has the properties:

• Namespace URI: Namespace name expressed as a URI to which the prefix is bound
• prefix: syntactically, this is the part of the attribute name following the XMLConstants.XMLNS_ATTRIBUTE ("xmlns") in the Namespace declaration

example: <element xmlns:prefix="http://Namespace-name-URI">

All get*(*) methods operate in the current scope for Namespace URI and prefix resolution.

Note that a Namespace URI can be bound to multiple prefixes in the current scope. This can occur when multiple XMLConstants.XMLNS_ATTRIBUTE ("xmlns") Namespace declarations occur in the same Start-Tag and refer to the same Namespace URI. e.g.

 <element xmlns:prefix1="http://Namespace-name-URI"
          xmlns:prefix2="http://Namespace-name-URI">
 

 <parent xmlns:prefix1="http://Namespace-name-URI">
   <child xmlns:prefix2="http://Namespace-name-URI">
     ...
   </child>
 </parent>
 

A prefix can only be bound to a single Namespace URI in the current scope.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

javax.XMLConstants for declarations of common XML values, XML Schema Part2: Datatypes, Namespaces in XML, Namespaces in XML Errata

javax.xml.namespace
Interface NamespaceContext

public interface NamespaceContext

Interface for read only XML Namespace context processing.

An XML Namespace has the properties:

• Namespace URI: Namespace name expressed as a URI to which the prefix is bound
• prefix: syntactically, this is the part of the attribute name following the XMLConstants.XMLNS_ATTRIBUTE ("xmlns") in the Namespace declaration

example: <element xmlns:prefix="http://Namespace-name-URI">

All get*(*) methods operate in the current scope for Namespace URI and prefix resolution.

Note that a Namespace URI can be bound to multiple prefixes in the current scope. This can occur when multiple XMLConstants.XMLNS_ATTRIBUTE ("xmlns") Namespace declarations occur in the same Start-Tag and refer to the same Namespace URI. e.g.

 <element xmlns:prefix1="http://Namespace-name-URI"
          xmlns:prefix2="http://Namespace-name-URI">
 

 <parent xmlns:prefix1="http://Namespace-name-URI">
   <child xmlns:prefix2="http://Namespace-name-URI">
     ...
   </child>
 </parent>
 

A prefix can only be bound to a single Namespace URI in the current scope.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

javax.xml.XMLConstants for declarations of common XML values, XML Schema Part2: Datatypes, Namespaces in XML, Namespaces in XML Errata

 java.lang.String getPrefix(java.lang.String namespaceURI)

Get prefix bound to Namespace URI in the current scope.

To get all prefixes bound to a Namespace URI in the current scope, use getPrefixes(String namespaceURI).

When requesting a prefix by Namespace URI, the following table describes the returned prefix value for all Namespace URI values:

		getPrefix(namespaceURI) return value for specified Namespace URIs
	Namespace URI parameter		prefix value returned
<default Namespace URI>	XMLConstants.DEFAULT_NS_PREFIX ("")
bound Namespace URI	prefix bound to Namespace URI in the current scope, if multiple prefixes are bound to the Namespace URI in the current scope, a single arbitrary prefix, whose choice is implementation dependent, is returned
unbound Namespace URI	null
XMLConstants.XML_NS_URI ("http://www.w3.org/XML/1998/namespace")	XMLConstants.XML_NS_PREFIX ("xml")
XMLConstants.XMLNS_ATTRIBUTE_NS_URI ("http://www.w3.org/2000/xmlns/")	XMLConstants.XMLNS_ATTRIBUTE ("xmlns")
null	IllegalArgumentException is thrown

Parameters:

namespaceURI - URI of Namespace to lookup

Returns:

prefix bound to Namespace URI in current context

Throws:

java.lang.IllegalArgumentException - When namespaceURI is null

java.lang.String getPrefix(java.lang.String namespaceURI)

Get prefix bound to Namespace URI in the current scope.

To get all prefixes bound to a Namespace URI in the current scope, use getPrefixes(String namespaceURI).

When requesting a prefix by Namespace URI, the following table describes the returned prefix value for all Namespace URI values:

getPrefix(namespaceURI) return value for specified Namespace URIs
Namespace URI parameter	prefix value returned
<default Namespace URI>	XMLConstants.DEFAULT_NS_PREFIX ("")
bound Namespace URI	prefix bound to Namespace URI in the current scope, if multiple prefixes are bound to the Namespace URI in the current scope, a single arbitrary prefix, whose choice is implementation dependent, is returned
unbound Namespace URI	null
XMLConstants.XML_NS_URI ("http://www.w3.org/XML/1998/namespace")	XMLConstants.XML_NS_PREFIX ("xml")
XMLConstants.XMLNS_ATTRIBUTE_NS_URI ("http://www.w3.org/2000/xmlns/")	XMLConstants.XMLNS_ATTRIBUTE ("xmlns")
null	IllegalArgumentException is thrown

Parameters:

namespaceURI - URI of Namespace to lookup

Returns:

prefix bound to Namespace URI in current context

java.lang.String getPrefix(java.lang.String namespaceURI)

Get prefix bound to Namespace URI in the current scope.

To get all prefixes bound to a Namespace URI in the current scope, use getPrefixes(String namespaceURI).

When requesting a prefix by Namespace URI, the following table describes the returned prefix value for all Namespace URI values:

getPrefix(namespaceURI) return value for specified Namespace URIs
Namespace URI parameter	prefix value returned
<default Namespace URI>	XMLConstants.DEFAULT_NS_PREFIX ("")
bound Namespace URI	prefix bound to Namespace URI in the current scope, if multiple prefixes are bound to the Namespace URI in the current scope, a single arbitrary prefix, whose choice is implementation dependent, is returned
unbound Namespace URI	null
XMLConstants.XML_NS_URI ("http://www.w3.org/XML/1998/namespace")	XMLConstants.XML_NS_PREFIX ("xml")
XMLConstants.XMLNS_ATTRIBUTE_NS_URI ("http://www.w3.org/2000/xmlns/")	XMLConstants.XMLNS_ATTRIBUTE ("xmlns")
null	IllegalArgumentException is thrown

Parameters:

namespaceURI - URI of Namespace to lookup

Returns:

prefix bound to Namespace URI in current context

Throws:

java.lang.IllegalArgumentException - When namespaceURI is null

javax.xml.namespace
Class QName

 java.lang.Object
  javax.xml.namespace.QName
 

public class QName

extends java.lang.Object

implements java.io.Serializable

QName represents a qualified name as defined in the XML specifications: XML Schema Part2: Datatypes specification , Namespaces in XML , Namespaces in XML Errata.

The value of a QName contains a Namespace URI , local part and prefix .

The prefix is included in QName to retain lexical information when present in an XML input source. The prefix is NOT used in QName.equals(Object) or to compute the QName.hashCode(). Equality and the hash code are defined using only the Namespace URI and local part.

If not specified, the Namespace URI is set to XMLConstants.NULL_NS_URI. If not specified, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

QName is immutable.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

XML Schema Part2: Datatypes specification XML Schema Part2: Datatypes specification , Namespaces in XML Namespaces in XML , Namespaces in XML Errata Namespaces in XML Errata , Serialized Form

javax.xml.namespace
Class QName

java.lang.Object
  javax.xml.namespace.QName

public class QName

extends java.lang.Object

implements java.io.Serializable

QName represents a qualified name as defined in the XML specifications: XML Schema Part2: Datatypes specification, Namespaces in XML, Namespaces in XML Errata.

The value of a QName contains a Namespace URI, local part and prefix.

The prefix is included in QName to retain lexical information when present in an XML input source. The prefix is NOT used in QName.equals(Object) or to compute the QName.hashCode(). Equality and the hash code are defined using only the Namespace URI and local part.

If not specified, the Namespace URI is set to XMLConstants.NULL_NS_URI. If not specified, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

QName is immutable.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

XML Schema Part2: Datatypes specification, Namespaces in XML, Namespaces in XML Errata, Serialized Form

javax.xml.namespace
Class QName

java.lang.Object
  javax.xml.namespace.QName

public class QName

extends java.lang.Object

implements java.io.Serializable

QName represents a qualified name as defined in the XML specifications: XML Schema Part2: Datatypes specification, Namespaces in XML, Namespaces in XML Errata.

The value of a QName contains a Namespace URI, local part and prefix.

The prefix is included in QName to retain lexical information when present in an XML input source. The prefix is NOT used in QName.equals(Object) or to compute the QName.hashCode(). Equality and the hash code are defined using only the Namespace URI and local part.

If not specified, the Namespace URI is set to XMLConstants.NULL_NS_URI. If not specified, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

QName is immutable.

Since:

1.5

Version:

$Revision: 1.2 $, $Date: 2008/01/24 18:12:22 $

Author:

Jeff Suttor

See Also:

XML Schema Part2: Datatypes specification, Namespaces in XML, Namespaces in XML Errata, Serialized Form

 public QName(java.lang.String localPart)

QName constructor specifying the local part.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the Namespace URI is set to XMLConstants.NULL_NS_URI and the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

In an XML context, all Element and Attribute names exist in the context of a Namespace. Making this explicit during the construction of a QName helps prevent hard to diagnosis XML validity errors. The constructors QName(String namespaceURI, String localPart) and QName(String namespaceURI, String localPart, String prefix) are preferred.

The local part is not validated as a NCName as specified in Namespaces in XML.

Parameters:

localPart - local part of the QName

Throws:

java.lang.IllegalArgumentException - When localPart is null

See Also:

QName(String namespaceURI, String localPart) , QName(String namespaceURI, String localPart, String prefix)

public QName(java.lang.String localPart)

QName constructor specifying the local part.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the Namespace URI is set to XMLConstants.NULL_NS_URI and the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

In an XML context, all Element and Attribute names exist in the context of a Namespace. Making this explicit during the construction of a QName helps prevent hard to diagnosis XML validity errors. The constructors QName(String namespaceURI, String localPart) and QName(String namespaceURI, String localPart, String prefix) are preferred.

The local part is not validated as a NCName as specified in Namespaces in XML.

Parameters:

localPart - local part of the QName

See Also:

QName(String namespaceURI, String localPart), QName(String namespaceURI, String localPart, String prefix)

public QName(java.lang.String localPart)

QName constructor specifying the local part.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the Namespace URI is set to XMLConstants.NULL_NS_URI and the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

In an XML context, all Element and Attribute names exist in the context of a Namespace. Making this explicit during the construction of a QName helps prevent hard to diagnosis XML validity errors. The constructors QName(String namespaceURI, String localPart) and QName(String namespaceURI, String localPart, String prefix) are preferred.

The local part is not validated as a NCName as specified in Namespaces in XML.

Parameters:

localPart - local part of the QName

Throws:

java.lang.IllegalArgumentException - When localPart is null

See Also:

QName(String namespaceURI, String localPart), QName(String namespaceURI, String localPart, String prefix)

 public QName(java.lang.String namespaceURI,
             java.lang.String localPart)

QName constructor specifying the Namespace URI and local part.

If the Namespace URI is null , it is set to XMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

The Namespace URI is not validated as a URI reference. The local part is not validated as a NCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

Throws:

java.lang.IllegalArgumentException - When localPart is null

See Also:

QName(String namespaceURI, String localPart, String prefix)

public QName(java.lang.String namespaceURI,
             java.lang.String localPart)

QName constructor specifying the Namespace URI and local part.

If the Namespace URI is null, it is set to XMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

The Namespace URI is not validated as a URI reference. The local part is not validated as a NCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

See Also:

QName(String namespaceURI, String localPart, String prefix)

public QName(java.lang.String namespaceURI,
             java.lang.String localPart)

QName constructor specifying the Namespace URI and local part.

If the Namespace URI is null, it is set to XMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

When using this constructor, the prefix is set to XMLConstants.DEFAULT_NS_PREFIX.

The Namespace URI is not validated as a URI reference. The local part is not validated as a NCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

Throws:

java.lang.IllegalArgumentException - When localPart is null

See Also:

QName(String namespaceURI, String localPart, String prefix)

 public QName(java.lang.String namespaceURI,
             java.lang.String localPart,
             java.lang.String prefix)

QName constructor specifying the Namespace URI, local part and prefix.

If the Namespace URI is null , it is set to XMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

If the prefix is null , an IllegalArgumentException is thrown. Use XMLConstants.DEFAULT_NS_PREFIX to explicitly indicate that no prefix is present or the prefix is not relevant.

The Namespace URI is not validated as a URI reference. The local part and prefix are not validated as a NCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

prefix - prefix of the QName

Throws:

java.lang.IllegalArgumentException - When localPart or prefix is null

QName

public QName(java.lang.String namespaceURI,
             java.lang.String localPart,
             java.lang.String prefix)

QName constructor specifying the Namespace URI, local part and prefix.

If the Namespace URI is null, it is set to XMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

If the prefix is null, an IllegalArgumentException is thrown. Use XMLConstants.DEFAULT_NS_PREFIX to explicitly indicate that no prefix is present or the prefix is not relevant.

The Namespace URI is not validated as a URI reference. The local part and prefix are not validated as a NCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

prefix - prefix of the QName

QName

public QName(java.lang.String namespaceURI,
             java.lang.String localPart,
             java.lang.String prefix)

QName constructor specifying the Namespace URI, local part and prefix.

If the Namespace URI is null, it is set to XMLConstants.NULL_NS_URI. This value represents no explicitly defined Namespace as defined by the Namespaces in XML specification. This action preserves compatible behavior with QName 1.0. Explicitly providing the XMLConstants.NULL_NS_URI value is the preferred coding style.

If the local part is null an IllegalArgumentException is thrown. A local part of "" is allowed to preserve compatible behavior with QName 1.0.

If the prefix is null, an IllegalArgumentException is thrown. Use XMLConstants.DEFAULT_NS_PREFIX to explicitly indicate that no prefix is present or the prefix is not relevant.

The Namespace URI is not validated as a URI reference. The local part and prefix are not validated as a NCName as specified in Namespaces in XML.

Parameters:

namespaceURI - Namespace URI of the QName

localPart - local part of the QName

prefix - prefix of the QName

Throws:

java.lang.IllegalArgumentException - When localPart or prefix is null

valueOf

 public static QName valueOf(java.lang.String qNameAsString)

valueOf

public static QName valueOf(java.lang.String qNameAsString)

valueOf

public static QName valueOf(java.lang.String qNameAsString)