public class DatatypeConfigurationException
extends java.lang.Exception

Indicates a serious configuration error.

Since:

1.5

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor

See Also:

Serialized Form

public class DatatypeConfigurationException
extends java.lang.Exception

Indicates a serious configuration error.

Since:

1.5

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor

See Also:

Serialized Form

public class DatatypeConfigurationException
extends java.lang.Exception

Indicates a serious configuration error.

Since:

1.5

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor

See Also:

Serialized Form

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() 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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli , Jeff Suttor , Neeraj Bajaj

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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli, Jeff Suttor

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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli, Jeff Suttor, Neeraj Bajaj

DATATYPEFACTORY_IMPLEMENTATION_CLASS

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 org.apache.xerces.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

DATATYPEFACTORY_IMPLEMENTATION_CLASS

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 org.apache.xerces.jaxp.datatype.DatatypeFactoryImpl.

See Also:

Constant Field Values

DATATYPEFACTORY_IMPLEMENTATION_CLASS

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.

Implementers should specify the name of an appropriate class to be instantiated if no other implementation resolution mechanism succeeds.

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

newDuration

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

newDuration

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)

newDuration

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

newDuration

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

newDuration

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.

newDuration

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

newDurationDayTime

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

newDurationDayTime

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.

newDurationDayTime

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 the values are not a valid representation of a Duration: if any of the fields (day, hour, ...) is negative.

newDurationDayTime

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

newDurationDayTime

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.

newDurationDayTime

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

newDurationDayTime

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.

newDurationDayTime

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.

newDurationDayTime

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.

newDurationYearMonth

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

newDurationYearMonth

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.

newDurationYearMonth

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 the values are not a valid representation of a Duration: if any of the fields (year, month) is negative.

newDurationYearMonth

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

newDurationYearMonth

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.

newDurationYearMonth

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

newDurationYearMonth

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.

newDurationYearMonth

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.

newDurationYearMonth

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.

newInstance

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)

newInstance

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.

newInstance

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)

newInstance

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.

See Also:

newInstance()

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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli , Kohsuke Kawaguchi , Jeff Suttor , Sunitha Reddy

See Also:

XMLGregorianCalendar.add(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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli, Kohsuke Kawaguchi, Jeff Suttor

See Also:

XMLGregorianCalendar.add(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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli, Kohsuke Kawaguchi, Jeff Suttor, Sunitha Reddy

See Also:

XMLGregorianCalendar.add(Duration)

equals

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)

equals

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)

equals

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)

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 , DatatypeConstants.TIME , DatatypeConstants.DATE , DatatypeConstants.GYEARMONTH , DatatypeConstants.GMONTHDAY , DatatypeConstants.GYEAR , DatatypeConstants.GMONTH , and DatatypeConstants.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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli , Kohsuke Kawaguchi , Jeff Suttor , Sunitha Reddy

See Also:

Duration , DatatypeFactory

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, DatatypeConstants.TIME, DatatypeConstants.DATE, DatatypeConstants.GYEARMONTH, DatatypeConstants.GMONTHDAY, DatatypeConstants.GYEAR, DatatypeConstants.GMONTH, and DatatypeConstants.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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli, Kohsuke Kawaguchi, Jeff Suttor

See Also:

Duration, DatatypeFactory

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, DatatypeConstants.TIME, DatatypeConstants.DATE, DatatypeConstants.GYEARMONTH, DatatypeConstants.GMONTHDAY, DatatypeConstants.GYEAR, DatatypeConstants.GMONTH, and DatatypeConstants.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: [scrubbed] $, $Revision: [scrubbed] $

Author:

Joseph Fialli, Kohsuke Kawaguchi, Jeff Suttor, Sunitha Reddy

See Also:

Duration, DatatypeFactory

equals

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.

equals

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.

equals

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 class DocumentBuilderFactory
extends java.lang.Object

Defines a factory API that enables applications to obtain a parser that produces DOM object trees from XML documents.

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor Jeff Suttor , Neeraj Bajaj

public abstract class DocumentBuilderFactory
extends java.lang.Object

Defines a factory API that enables applications to obtain a parser that produces DOM object trees from XML documents.

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor

public abstract class DocumentBuilderFactory
extends java.lang.Object

Defines a factory API that enables applications to obtain a parser that produces DOM object trees from XML documents.

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor, Neeraj Bajaj

getSchema

public Schema getSchema()

Gets the Schema object specified through the setSchema(Schema schema) method.

Returns:

the Schema object that was last set through the setSchema(Schema) method, or null if the method was not invoked since a DocumentBuilderFactory SAXParserFactory is created.

Throws:

java.lang.UnsupportedOperationException - When implementation does not override this method.

Since:

1.5

getSchema

public Schema getSchema()

Gets the Schema object specified through the setSchema(Schema schema) method.

Returns:

the Schema object that was last set through the setSchema(Schema) method, or null if the method was not invoked since a SAXParserFactory is created.

Throws:

java.lang.UnsupportedOperationException - When implementation does not override this method.

Since:

1.5

getSchema

public Schema getSchema()

Gets the Schema object specified through the setSchema(Schema schema) method.

Returns:

the Schema object that was last set through the setSchema(Schema) method, or null if the method was not invoked since a DocumentBuilderFactory is created.

Throws:

java.lang.UnsupportedOperationException - When implementation does not override this method.

Since:

1.5

newInstance

public static DocumentBuilderFactory newInstance(java.lang.String factoryClassName,
                                                 java.lang.ClassLoader classLoader)

Obtain a new instance of a DocumentBuilderFactory 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 DocumentBuilderFactory it can use the factory to configure and obtain parser 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.parsers.DocumentBuilderFactory.

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 DocumentBuilderFactory

Throws:

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

See Also:

newInstance()

setFeature

public abstract void setFeature(java.lang.String name,
                                boolean value)
                         throws ParserConfigurationException

Set a feature for this DocumentBuilderFactory and DocumentBuilder s created by this factory.

Feature names are fully qualified URI s. Implementations may define their own features. A An ParserConfigurationException is thrown if this DocumentBuilderFactory or the DocumentBuilder s it creates cannot support the feature. It is possible for a an DocumentBuilderFactory to expose a feature value but be unable to change its state.

All implementations are required to support the XMLConstants.FEATURE_SECURE_PROCESSING feature. When the feature is:

• true : the implementation will limit XML processing to conform to implementation limits. Examples include enity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered ErrorHandler.fatalError(SAXParseException exception) . See DocumentBuilder.setErrorHandler(org.xml.sax.ErrorHandler errorHandler) .
• false : the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

Parameters:

name - Feature name.

value - Is feature state true or false.

Throws:

ParserConfigurationException - if this DocumentBuilderFactory or the DocumentBuilder s it creates cannot support this feature.

java.lang.NullPointerException - If the name parameter is null.

setFeature

public abstract void setFeature(java.lang.String name,
                                boolean value)
                         throws ParserConfigurationException

Set a feature for this DocumentBuilderFactory and DocumentBuilders created by this factory.

Feature names are fully qualified URIs. Implementations may define their own features. An ParserConfigurationException is thrown if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support the feature. It is possible for an DocumentBuilderFactory to expose a feature value but be unable to change its state.

All implementations are required to support the XMLConstants.FEATURE_SECURE_PROCESSING feature. When the feature is:

• true: the implementation will limit XML processing to conform to implementation limits. Examples include enity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered ErrorHandler.fatalError(SAXParseException exception). See DocumentBuilder.setErrorHandler(org.xml.sax.ErrorHandler errorHandler).
• false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

Parameters:

name - Feature name.

value - Is feature state true or false.

Throws:

ParserConfigurationException - if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.

java.lang.NullPointerException - If the name parameter is null.

setFeature

public abstract void setFeature(java.lang.String name,
                                boolean value)
                         throws ParserConfigurationException

Set a feature for this DocumentBuilderFactory and DocumentBuilders created by this factory.

Feature names are fully qualified URIs. Implementations may define their own features. A ParserConfigurationException is thrown if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support the feature. It is possible for a DocumentBuilderFactory to expose a feature value but be unable to change its state.

All implementations are required to support the XMLConstants.FEATURE_SECURE_PROCESSING feature. When the feature is:

• true: the implementation will limit XML processing to conform to implementation limits. Examples include enity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered ErrorHandler.fatalError(SAXParseException exception). See DocumentBuilder.setErrorHandler(org.xml.sax.ErrorHandler errorHandler).
• false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

Parameters:

name - Feature name.

value - Is feature state true or false.

Throws:

ParserConfigurationException - if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.

java.lang.NullPointerException - If the name parameter is null.

setSchema

public void setSchema(Schema schema)

Set the Schema to be used by parsers created from this factory.

When a Schema is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.

When errors are found by the validator, the parser is responsible to report them to the user-specified ErrorHandler DOMErrorHandler (or if the error handler is not set, ignore them or throw them), just like any other errors found by the parser itself. In other words, if the user-specified ErrorHandler DOMErrorHandler is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.

A validator may modify the outcome of a parse (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive modified DOM trees.

Initialy, null is set as the Schema .

This processing will take effect even if the isValidating() method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a Schema object. Such configuration will cause a ParserConfigurationException exception when the newDocumentBuilder() is invoked.

Note for implmentors

A parser must be able to work with any Schema implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.

Parameters:

schema - Schema to use or null to remove a schema.

Throws:

java.lang.UnsupportedOperationException - When implementation does not override this method.

Since:

1.5

setSchema

public void setSchema(Schema schema)

Set the Schema to be used by parsers created from this factory.

When a Schema is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.

When errors are found by the validator, the parser is responsible to report them to the user-specified DOMErrorHandler (or if the error handler is not set, ignore them or throw them), just like any other errors found by the parser itself. In other words, if the user-specified DOMErrorHandler is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.

A validator may modify the outcome of a parse (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive modified DOM trees.

Initialy, null is set as the Schema.

This processing will take effect even if the isValidating() method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a Schema object. Such configuration will cause a ParserConfigurationException exception when the newDocumentBuilder() is invoked.

Note for implmentors

A parser must be able to work with any Schema implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.

Parameters:

schema - Schema to use or null to remove a schema.

Throws:

java.lang.UnsupportedOperationException - When implementation does not override this method.

Since:

1.5

setSchema

public void setSchema(Schema schema)

Set the Schema to be used by parsers created from this factory.

When a Schema is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.

When errors are found by the validator, the parser is responsible to report them to the user-specified ErrorHandler (or if the error handler is not set, ignore them or throw them), just like any other errors found by the parser itself. In other words, if the user-specified ErrorHandler is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.

A validator may modify the outcome of a parse (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive modified DOM trees.

Initialy, null is set as the Schema.

This processing will take effect even if the isValidating() method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a Schema object. Such configuration will cause a ParserConfigurationException exception when the newDocumentBuilder() is invoked.

Note for implmentors

A parser must be able to work with any Schema implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.

Parameters:

schema - Schema to use or null to remove a schema.

Throws:

java.lang.UnsupportedOperationException - When implementation does not override this method.

Since:

1.5

public abstract class SAXParserFactory
extends java.lang.Object

Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor Jeff Suttor , Neeraj Bajaj

public abstract class SAXParserFactory
extends java.lang.Object

Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor

public abstract class SAXParserFactory
extends java.lang.Object

Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.

Version:

$Revision: [scrubbed] $, $Revision: [scrubbed] $

Author:

Jeff Suttor, Neeraj Bajaj

newInstance

public static SAXParserFactory newInstance(java.lang.String factoryClassName,
                                           java.lang.ClassLoader classLoader)

Obtain a new instance of a SAXParserFactory 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 SAXParserFactory it can use the factory to configure and obtain parser 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.parsers.DocumentBuilderFactory.

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 SAXParserFactory

Throws:

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

See Also:

newInstance()

public interface EventFilter

This interface declares a simple filter interface that one can create to filter XMLEventReaders

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

accept

boolean accept(XMLEvent event)

Tests whether this event is part of this stream. This method will return true if this filter accepts this event and false otherwise.

Parameters:

event - the event to test

Returns:

true if this filter accepts this event, false otherwise

public class FactoryConfigurationError
extends java.lang.Error

An error class for reporting factory configuration errors.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

Serialized Form

FactoryConfigurationError

public FactoryConfigurationError()

Default constructor

FactoryConfigurationError

public FactoryConfigurationError(java.lang.Exception e)

Construct an exception with a nested inner exception

Parameters:

e - the exception to nest

FactoryConfigurationError

public FactoryConfigurationError(java.lang.Exception e,
                                 java.lang.String msg)

Construct an exception with a nested inner exception and a message

Parameters:

e - the exception to nest

msg - the message to report

FactoryConfigurationError

public FactoryConfigurationError(java.lang.String msg)

Construct an exception with associated message

Parameters:

msg - the message to report

FactoryConfigurationError

public FactoryConfigurationError(java.lang.String msg,
                                 java.lang.Exception e)

Construct an exception with a nested inner exception and a message

Parameters:

msg - the message to report

e - the exception to nest

getException

public java.lang.Exception getException()

Return the nested exception (if any)

Returns:

the nested exception or null

getMessage

public java.lang.String getMessage()

Report the message associated with this error

Overrides:

getMessage in class java.lang.Throwable

Returns:

the string value of the message

public interface Location

Provides information on the location of an event. All the information provided by a Location is optional. For example an application may only report line numbers.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

getCharacterOffset

int getCharacterOffset()

Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available.

Returns:

the current offset

getColumnNumber

int getColumnNumber()

Return the column number where the current event ends, returns -1 if none is available.

Returns:

the current column number

getLineNumber

int getLineNumber()

Return the line number where the current event ends, returns -1 if none is available.

Returns:

the current line number

getPublicId

java.lang.String getPublicId()

Returns the public ID of the XML

Returns:

the public ID, or null if not available

getSystemId

java.lang.String getSystemId()

Returns the system ID of the XML

Returns:

the system ID, or null if not available

public interface StreamFilter

This interface declares a simple filter interface that one can create to filter XMLStreamReaders

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

accept

boolean accept(XMLStreamReader reader)

Tests whether the current state is part of this stream. This method will return true if this filter accepts this event and false otherwise. The method should not change the state of the reader when accepting a state.

Parameters:

reader - the event to test

Returns:

true if this filter accepts this event, false otherwise

public abstract class XMLEventFactory
extends java.lang.Object

This interface defines a utility class for creating instances of XMLEvents

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

StartElement, EndElement, ProcessingInstruction, Comment, Characters, StartDocument, EndDocument, DTD

XMLEventFactory

protected XMLEventFactory()

createAttribute

public abstract Attribute createAttribute(java.lang.String localName,
                                          java.lang.String value)

Create a new Attribute

Parameters:

localName - the local name of the XML name of the attribute, localName cannot be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

createAttribute

public abstract Attribute createAttribute(java.lang.String prefix,
                                          java.lang.String namespaceURI,
                                          java.lang.String localName,
                                          java.lang.String value)

Create a new Attribute

Parameters:

prefix - the prefix of this attribute, may not be null

namespaceURI - the attribute value is set to this value, may not be null

localName - the local name of the XML name of the attribute, localName cannot be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

createAttribute

public abstract Attribute createAttribute(QName name,
                                          java.lang.String value)

Create a new Attribute

Parameters:

name - the qualified name of the attribute, may not be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

createCData

public abstract Characters createCData(java.lang.String content)

Create a Characters event with the CData flag set to true

Parameters:

content - the string to create

Returns:

a Characters event

createCharacters

public abstract Characters createCharacters(java.lang.String content)

Create a Characters event, this method does not check if the content is all whitespace. To create a space event use #createSpace(String)

Parameters:

content - the string to create

Returns:

a Characters event

createComment

public abstract Comment createComment(java.lang.String text)

Create a comment

Parameters:

text - The text of the comment a Comment event

createDTD

public abstract DTD createDTD(java.lang.String dtd)

Create a document type definition event This string contains the entire document type declaration that matches the doctypedecl in the XML 1.0 specification

Parameters:

dtd - the text of the document type definition

Returns:

a DTD event

createEndDocument

public abstract EndDocument createEndDocument()

Creates a new instance of an EndDocument event

Returns:

an EndDocument event

createEndElement

public abstract EndElement createEndElement(java.lang.String prefix,
                                            java.lang.String namespaceUri,
                                            java.lang.String localName)

Create a new EndElement

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

Returns:

an instance of the requested EndElement

createEndElement

public abstract EndElement createEndElement(java.lang.String prefix,
                                            java.lang.String namespaceUri,
                                            java.lang.String localName,
                                            java.util.Iterator namespaces)

Create a new EndElement

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

namespaces - an unordered set of objects that implement Namespace that have gone out of scope, may be null

Returns:

an instance of the requested EndElement

createEndElement

public abstract EndElement createEndElement(QName name,
                                            java.util.Iterator namespaces)

Create a new EndElement

Parameters:

name - the qualified name of the EndElement

namespaces - an optional unordered set of objects that implement Namespace that have gone out of scope, may be null

Returns:

an instance of the requested EndElement

createEntityReference

public abstract EntityReference createEntityReference(java.lang.String name,
                                                      EntityDeclaration declaration)

Creates a new instance of a EntityReference event

Parameters:

name - The name of the reference

declaration - the declaration for the event

Returns:

an EntityReference event

createIgnorableSpace

public abstract Characters createIgnorableSpace(java.lang.String content)

Create an ignorable space

Parameters:

content - the space to create

Returns:

a Characters event

createNamespace

public abstract Namespace createNamespace(java.lang.String namespaceURI)

Create a new default Namespace

Parameters:

namespaceURI - the default namespace uri

Returns:

the Namespace with the specified value

createNamespace

public abstract Namespace createNamespace(java.lang.String prefix,
                                          java.lang.String namespaceUri)

Create a new Namespace

Parameters:

prefix - the prefix of this namespace, may not be null

namespaceUri - the attribute value is set to this value, may not be null

Returns:

the Namespace with the specified values

createProcessingInstruction

public abstract ProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                                  java.lang.String data)

Create a processing instruction

Parameters:

target - The target of the processing instruction

data - The text of the processing instruction

Returns:

a ProcessingInstruction event

createSpace

public abstract Characters createSpace(java.lang.String content)

Create a Characters event with the isSpace flag set to true

Parameters:

content - the content of the space to create

Returns:

a Characters event

createStartDocument

public abstract StartDocument createStartDocument()

Creates a new instance of a StartDocument event

Returns:

a StartDocument event

createStartDocument

public abstract StartDocument createStartDocument(java.lang.String encoding)

Creates a new instance of a StartDocument event

Parameters:

encoding - the encoding style

Returns:

a StartDocument event

createStartDocument

public abstract StartDocument createStartDocument(java.lang.String encoding,
                                                  java.lang.String version)

Creates a new instance of a StartDocument event

Parameters:

encoding - the encoding style

version - the XML version

Returns:

a StartDocument event

createStartDocument

public abstract StartDocument createStartDocument(java.lang.String encoding,
                                                  java.lang.String version,
                                                  boolean standalone)

Creates a new instance of a StartDocument event

Parameters:

encoding - the encoding style

version - the XML version

standalone - the status of standalone may be set to "true" or "false"

Returns:

a StartDocument event

createStartElement

public abstract StartElement createStartElement(java.lang.String prefix,
                                                java.lang.String namespaceUri,
                                                java.lang.String localName)

Create a new StartElement. This defaults the NamespaceContext to an empty NamespaceContext. Querying this event for its namespaces or attributes will result in an empty iterator being returned.

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

Returns:

an instance of the requested StartElement

createStartElement

public abstract StartElement createStartElement(java.lang.String prefix,
                                                java.lang.String namespaceUri,
                                                java.lang.String localName,
                                                java.util.Iterator attributes,
                                                java.util.Iterator namespaces)

Create a new StartElement. Namespaces can be added to this StartElement by passing in an Iterator that walks over a set of Namespace interfaces. Attributes can be added to this StartElement by passing an iterator that walks over a set of Attribute interfaces.

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

attributes - an unordered set of objects that implement Attribute to add to the new StartElement

namespaces - an unordered set of objects that implement Namespace to add to the new StartElement

Returns:

an instance of the requested StartElement

createStartElement

public abstract StartElement createStartElement(java.lang.String prefix,
                                                java.lang.String namespaceUri,
                                                java.lang.String localName,
                                                java.util.Iterator attributes,
                                                java.util.Iterator namespaces,
                                                NamespaceContext context)

Create a new StartElement. Namespaces can be added to this StartElement by passing in an Iterator that walks over a set of Namespace interfaces. Attributes can be added to this StartElement by passing an iterator that walks over a set of Attribute interfaces.

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

attributes - an unordered set of objects that implement Attribute to add to the new StartElement, may be null

namespaces - an unordered set of objects that implement Namespace to add to the new StartElement, may be null

context - the namespace context of this element

Returns:

an instance of the requested StartElement

createStartElement

public abstract StartElement createStartElement(QName name,
                                                java.util.Iterator attributes,
                                                java.util.Iterator namespaces)

Create a new StartElement. Namespaces can be added to this StartElement by passing in an Iterator that walks over a set of Namespace interfaces. Attributes can be added to this StartElement by passing an iterator that walks over a set of Attribute interfaces.

Parameters:

name - the qualified name of the attribute, may not be null

attributes - an optional unordered set of objects that implement Attribute to add to the new StartElement, may be null

namespaces - an optional unordered set of objects that implement Namespace to add to the new StartElement, may be null

Returns:

an instance of the requested StartElement

newInstance

public static XMLEventFactory newInstance()
                                   throws FactoryConfigurationError

Create a new instance of the factory

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

newInstance

public static XMLEventFactory newInstance(java.lang.String factoryId,
                                          java.lang.ClassLoader classLoader)
                                   throws FactoryConfigurationError

Create a new instance of the factory

Parameters:

factoryId - Name of the factory to find, same as a property name

classLoader - classLoader to use

Returns:

the factory implementation

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

setLocation

public abstract void setLocation(Location location)

This method allows setting of the Location on each event that is created by this factory. The values are copied by value into the events created by this factory. To reset the location information set the location to null.

Parameters:

location - the location to set on each event created

public interface XMLEventReader
extends java.util.Iterator

This is the top level interface for parsing XML Events. It provides the ability to peek at the next event and returns configuration information through the property interface.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

XMLInputFactory, XMLEventWriter

close

void close()
           throws XMLStreamException

Frees any resources associated with this Reader. This method does not close the underlying input source.

Throws:

XMLStreamException - if there are errors freeing associated resources

getElementText

java.lang.String getElementText()
                                throws XMLStreamException

Reads the content of a text-only element. Precondition: the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.

Throws:

XMLStreamException - if the current event is not a START_ELEMENT or if a non text element is encountered

getProperty

java.lang.Object getProperty(java.lang.String name)
                             throws java.lang.IllegalArgumentException

Get the value of a feature/property from the underlying implementation

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.IllegalArgumentException - if the property is not supported

hasNext

boolean hasNext()

Check if there are more events. Returns true if there are more events and false otherwise.

Specified by:

hasNext in interface java.util.Iterator

Returns:

true if the event reader has more events, false otherwise

nextEvent

XMLEvent nextEvent()
                   throws XMLStreamException

Get the next XMLEvent

Throws:

XMLStreamException - if there is an error with the underlying XML.

NoSuchElementException - iteration has no more elements.

See Also:

XMLEvent

nextTag

XMLEvent nextTag()
                 throws XMLStreamException

Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached. If anything other than space characters are encountered, an exception is thrown. This method should be used when processing element-only content because the parser is not able to recognize ignorable whitespace if the DTD is missing or not interpreted.

Throws:

XMLStreamException - if anything other than space characters are encountered

peek

XMLEvent peek()
              throws XMLStreamException

Check the next XMLEvent without reading it from the stream. Returns null if the stream is at EOF or has no more XMLEvents. A call to peek() will be equal to the next return of next().

Throws:

XMLStreamException

See Also:

XMLEvent

public interface XMLEventWriter
extends XMLEventConsumer

This is the top level interface for writing XML documents. Instances of this interface are not required to validate the form of the XML.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

XMLEventReader, XMLEvent, Characters, ProcessingInstruction, StartElement, EndElement

add

void add(XMLEventReader reader)
         throws XMLStreamException

Adds an entire stream to an output stream, calls next() on the inputStream argument until hasNext() returns false This should be treated as a convenience method that will perform the following loop over all the events in an event reader and call add on each event.

Parameters:

reader - the event stream to add to the output

Throws:

XMLStreamException

add

void add(XMLEvent event)
         throws XMLStreamException

Add an event to the output stream Adding a START_ELEMENT will open a new namespace scope that will be closed when the corresponding END_ELEMENT is written.

Required and optional fields for events added to the writer
Event Type	Required Fields	Optional Fields	Required Behavior
START_ELEMENT	QName name	namespaces , attributes	A START_ELEMENT will be written by writing the name, namespaces, and attributes of the event in XML 1.0 valid syntax for START_ELEMENTs. The name is written by looking up the prefix for the namespace uri. The writer can be configured to respect prefixes of QNames. If the writer is respecting prefixes it must use the prefix set on the QName. The default behavior is to lookup the value for the prefix on the EventWriter's internal namespace context. Each attribute (if any) is written using the behavior specified in the attribute section of this table. Each namespace (if any) is written using the behavior specified in the namespace section of this table.
END_ELEMENT	Qname name	None	A well formed END_ELEMENT tag is written. The name is written by looking up the prefix for the namespace uri. The writer can be configured to respect prefixes of QNames. If the writer is respecting prefixes it must use the prefix set on the QName. The default behavior is to lookup the value for the prefix on the EventWriter's internal namespace context. If the END_ELEMENT name does not match the START_ELEMENT name an XMLStreamException is thrown.
ATTRIBUTE	QName name , String value	QName type	An attribute is written using the same algorithm to find the lexical form as used in START_ELEMENT. The default is to use double quotes to wrap attribute values and to escape any double quotes found in the value. The type value is ignored.
NAMESPACE	String prefix, String namespaceURI, boolean isDefaultNamespaceDeclaration	None	A namespace declaration is written. If the namespace is a default namespace declaration (isDefault is true) then xmlns="$namespaceURI" is written and the prefix is optional. If isDefault is false, the prefix must be declared and the writer must prepend xmlns to the prefix and write out a standard prefix declaration.
PROCESSING_INSTRUCTION	None	String target, String data	The data does not need to be present and may be null. Target is required and many not be null. The writer will write data section directly after the target, enclosed in appropriate XML 1.0 syntax
COMMENT	None	String comment	If the comment is present (not null) it is written, otherwise an an empty comment is written
START_DOCUMENT	None	String encoding , boolean standalone, String version	A START_DOCUMENT event is not required to be written to the stream. If present the attributes are written inside the appropriate XML declaration syntax
END_DOCUMENT	None	None	Nothing is written to the output
DTD	String DocumentTypeDefinition	None	The DocumentTypeDefinition is written to the output

Specified by:

add in interface XMLEventConsumer

Parameters:

event - the event to be added

Throws:

XMLStreamException

close

void close()
           throws XMLStreamException

Frees any resources associated with this stream

Throws:

XMLStreamException

flush

void flush()
           throws XMLStreamException

Writes any cached events to the underlying output mechanism

Throws:

XMLStreamException

getNamespaceContext

NamespaceContext getNamespaceContext()

Returns the current namespace context.

Returns:

the current namespace context

getPrefix

java.lang.String getPrefix(java.lang.String uri)
                           throws XMLStreamException

Gets the prefix the uri is bound to

Parameters:

uri - the uri to look up

Throws:

XMLStreamException

setDefaultNamespace

void setDefaultNamespace(java.lang.String uri)
                         throws XMLStreamException

Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope.

Parameters:

uri - the uri to bind to the default namespace

Throws:

XMLStreamException

setNamespaceContext

void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context. Subsequent calls to setPrefix and setDefaultNamespace will bind namespaces using the context passed to the method as the root context for resolving namespaces.

Parameters:

context - the namespace context to use for this writer

Throws:

XMLStreamException

setPrefix

void setPrefix(java.lang.String prefix,
               java.lang.String uri)
               throws XMLStreamException

Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope.

Parameters:

prefix - the prefix to bind to the uri

uri - the uri to bind to the prefix

Throws:

XMLStreamException

public abstract class XMLInputFactory
extends java.lang.Object

Defines an abstract implementation of a factory for getting streams. The following table defines the standard properties of this specification. Each property varies in the level of support required by each implementation. The level of support required is described in the 'Required' column.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

XMLOutputFactory, XMLEventReader, XMLStreamReader, EventFilter, XMLReporter, XMLResolver, XMLEventAllocator

XMLInputFactory

protected XMLInputFactory()

ALLOCATOR

public static final java.lang.String ALLOCATOR

The property used to set/get the implementation of the allocator

See Also:

Constant Field Values

IS_COALESCING

public static final java.lang.String IS_COALESCING

The property that requires the parser to coalesce adjacent character data sections

See Also:

Constant Field Values

IS_NAMESPACE_AWARE

public static final java.lang.String IS_NAMESPACE_AWARE

The property used to turn on/off namespace support, this is to support XML 1.0 documents, only the true setting must be supported

See Also:

Constant Field Values

IS_REPLACING_ENTITY_REFERENCES

public static final java.lang.String IS_REPLACING_ENTITY_REFERENCES

Requires the parser to replace internal entity references with their replacement text and report them as characters

See Also:

Constant Field Values

IS_SUPPORTING_EXTERNAL_ENTITIES

public static final java.lang.String IS_SUPPORTING_EXTERNAL_ENTITIES

The property that requires the parser to resolve external parsed entities

See Also:

Constant Field Values

IS_VALIDATING

public static final java.lang.String IS_VALIDATING

The property used to turn on/off implementation specific validation

See Also:

Constant Field Values

REPORTER

public static final java.lang.String REPORTER

The property used to set/get the implementation of the XMLReporter interface

See Also:

Constant Field Values

RESOLVER

public static final java.lang.String RESOLVER

The property used to set/get the implementation of the XMLResolver

See Also:

Constant Field Values

SUPPORT_DTD

public static final java.lang.String SUPPORT_DTD

The property that requires the parser to support DTDs

See Also:

Constant Field Values

createFilteredReader

public abstract XMLEventReader createFilteredReader(XMLEventReader reader,
                                                    EventFilter filter)
                                             throws XMLStreamException

Create a filtered event reader that wraps the filter around the event reader

Parameters:

reader - the event reader to wrap

filter - the filter to apply to the event reader

Throws:

XMLStreamException

createFilteredReader

public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader,
                                                     StreamFilter filter)
                                              throws XMLStreamException

Create a filtered reader that wraps the filter around the reader

Parameters:

reader - the reader to filter

filter - the filter to apply to the reader

Throws:

XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(java.io.InputStream stream)
                                             throws XMLStreamException

Create a new XMLEventReader from a java.io.InputStream

Parameters:

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(java.io.InputStream stream,
                                                    java.lang.String encoding)
                                             throws XMLStreamException

Create a new XMLEventReader from a java.io.InputStream

Parameters:

stream - the InputStream to read from

encoding - the character encoding of the stream

Throws:

XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(java.io.Reader reader)
                                             throws XMLStreamException

Create a new XMLEventReader from a reader

Parameters:

reader - the XML data to read from

Throws:

XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(java.lang.String systemId,
                                                    java.io.InputStream stream)
                                             throws XMLStreamException

Create a new XMLEventReader from a java.io.InputStream

Parameters:

systemId - the system ID of the stream

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(java.lang.String systemId,
                                                    java.io.Reader reader)
                                             throws XMLStreamException

Create a new XMLEventReader from a reader

Parameters:

systemId - the system ID of the input

reader - the XML data to read from

Throws:

XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
                                             throws XMLStreamException

Create a new XMLEventReader from an XMLStreamReader. After being used to construct the XMLEventReader instance returned from this method the XMLStreamReader must not be used.

Parameters:

reader - the XMLStreamReader to read from (may not be modified)

Returns:

a new XMLEventReader

Throws:

XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(Source source)
                                             throws XMLStreamException

Create a new XMLEventReader from a JAXP source. Support of this method is optional.

Parameters:

source - the source to read from

Throws:

java.lang.UnsupportedOperationException - if this method is not supported by this XMLInputFactory

XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(java.io.InputStream stream)
                                               throws XMLStreamException

Create a new XMLStreamReader from a java.io.InputStream

Parameters:

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(java.io.InputStream stream,
                                                      java.lang.String encoding)
                                               throws XMLStreamException

Create a new XMLStreamReader from a java.io.InputStream

Parameters:

stream - the InputStream to read from

encoding - the character encoding of the stream

Throws:

XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(java.io.Reader reader)
                                               throws XMLStreamException

Create a new XMLStreamReader from a reader

Parameters:

reader - the XML data to read from

Throws:

XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(java.lang.String systemId,
                                                      java.io.InputStream stream)
                                               throws XMLStreamException

Create a new XMLStreamReader from a java.io.InputStream

Parameters:

systemId - the system ID of the stream

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(java.lang.String systemId,
                                                      java.io.Reader reader)
                                               throws XMLStreamException

Create a new XMLStreamReader from a java.io.InputStream

Parameters:

systemId - the system ID of the stream

reader - the InputStream to read from

Throws:

XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(Source source)
                                               throws XMLStreamException

Create a new XMLStreamReader from a JAXP source. This method is optional.

Parameters:

source - the source to read from

Throws:

java.lang.UnsupportedOperationException - if this method is not supported by this XMLInputFactory

XMLStreamException

getEventAllocator

public abstract XMLEventAllocator getEventAllocator()

Gets the allocator used by streams created with this factory

getProperty

public abstract java.lang.Object getProperty(java.lang.String name)
                                      throws java.lang.IllegalArgumentException

Get the value of a feature/property from the underlying implementation

Parameters:

name - The name of the property (may not be null)

Returns:

The value of the property

Throws:

java.lang.IllegalArgumentException - if the property is not supported

getXMLReporter

public abstract XMLReporter getXMLReporter()

The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

getXMLResolver

public abstract XMLResolver getXMLResolver()

The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

isPropertySupported

public abstract boolean isPropertySupported(java.lang.String name)

Query the set of properties that this factory supports.

Parameters:

name - The name of the property (may not be null)

Returns:

true if the property is supported and false otherwise

newInstance

public static XMLInputFactory newInstance()
                                   throws FactoryConfigurationError

Create a new instance of the factory. This static method creates a new factory instance. This method uses the following ordered lookup procedure to determine the XMLInputFactory implementation class to load: Use the javax.xml.stream.XMLInputFactory system property. Use the properties file "lib/stax.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above. Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.stream.XMLInputFactory in jars available to the runtime. Platform default XMLInputFactory instance. Once an application has obtained a reference to a XMLInputFactory it can use the factory to configure and obtain stream instances.

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

newInstance

public static XMLInputFactory newInstance(java.lang.String factoryId,
                                          java.lang.ClassLoader classLoader)
                                   throws FactoryConfigurationError

Create a new instance of the factory

Parameters:

factoryId - Name of the factory to find, same as a property name

classLoader - classLoader to use

Returns:

the factory implementation

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

setEventAllocator

public abstract void setEventAllocator(XMLEventAllocator allocator)

Set a user defined event allocator for events

Parameters:

allocator - the user defined allocator

setProperty

public abstract void setProperty(java.lang.String name,
                                 java.lang.Object value)
                          throws java.lang.IllegalArgumentException

Allows the user to set specific feature/property on the underlying implementation. The underlying implementation is not required to support every setting of every property in the specification and may use IllegalArgumentException to signal that an unsupported property may not be set with the specified value.

Parameters:

name - The name of the property (may not be null)

value - The value of the property

Throws:

java.lang.IllegalArgumentException - if the property is not supported

setXMLReporter

public abstract void setXMLReporter(XMLReporter reporter)

The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

Parameters:

reporter - the resolver to use to report non fatal errors

setXMLResolver

public abstract void setXMLResolver(XMLResolver resolver)

The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

Parameters:

resolver - the resolver to use to resolve references

public abstract class XMLOutputFactory
extends java.lang.Object

Defines an abstract implementation of a factory for getting XMLEventWriters and XMLStreamWriters. The following table defines the standard properties of this specification. Each property varies in the level of support required by each implementation. The level of support required is described in the 'Required' column.

The following paragraphs describe the namespace and prefix repair algorithm:

The property can be set with the following code line: setProperty("javax.xml.stream.isRepairingNamespaces",new Boolean(true|false));

This property specifies that the writer default namespace prefix declarations. The default value is false.

If a writer isRepairingNamespaces it will create a namespace declaration on the current StartElement for any attribute that does not currently have a namespace declaration in scope. If the StartElement has a uri but no prefix specified a prefix will be assigned, if the prefix has not been declared in a parent of the current StartElement it will be declared on the current StartElement. If the defaultNamespace is bound and in scope and the default namespace matches the URI of the attribute or StartElement QName no prefix will be assigned.

If an element or attribute name has a prefix, but is not bound to any namespace URI, then the prefix will be removed during serialization.

If element and/or attribute names in the same start or empty-element tag are bound to different namespace URIs and are using the same prefix then the element or the first occurring attribute retains the original prefix and the following attributes have their prefixes replaced with a new prefix that is bound to the namespace URIs of those attributes.

If an element or attribute name uses a prefix that is bound to a different URI than that inherited from the namespace context of the parent of that element and there is no namespace declaration in the context of the current element then such a namespace declaration is added.

If an element or attribute name is bound to a prefix and there is a namespace declaration that binds that prefix to a different URI then that namespace declaration is either removed if the correct mapping is inherited from the parent context of that element, or changed to the namespace URI of the element or attribute using that prefix.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

XMLInputFactory, XMLEventWriter, XMLStreamWriter

XMLOutputFactory

protected XMLOutputFactory()

IS_REPAIRING_NAMESPACES

public static final java.lang.String IS_REPAIRING_NAMESPACES

Property used to set prefix defaulting on the output side

See Also:

Constant Field Values

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream)
                                             throws XMLStreamException

Create a new XMLEventWriter that writes to a stream

Parameters:

stream - the stream to write to

Throws:

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream,
                                                    java.lang.String encoding)
                                             throws XMLStreamException

Create a new XMLEventWriter that writes to a stream

Parameters:

stream - the stream to write to

encoding - the encoding to use

Throws:

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(java.io.Writer stream)
                                             throws XMLStreamException

Create a new XMLEventWriter that writes to a writer

Parameters:

stream - the stream to write to

Throws:

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(Result result)
                                             throws XMLStreamException

Create a new XMLEventWriter that writes to a JAXP result. This method is optional.

Parameters:

result - the result to write to

Throws:

java.lang.UnsupportedOperationException - if this method is not supported by this XMLOutputFactory

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream)
                                               throws XMLStreamException

Create a new XMLStreamWriter that writes to a stream

Parameters:

stream - the stream to write to

Throws:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream,
                                                      java.lang.String encoding)
                                               throws XMLStreamException

Create a new XMLStreamWriter that writes to a stream

Parameters:

stream - the stream to write to

encoding - the encoding to use

Throws:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(java.io.Writer stream)
                                               throws XMLStreamException

Create a new XMLStreamWriter that writes to a writer

Parameters:

stream - the writer to write to

Throws:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(Result result)
                                               throws XMLStreamException

Create a new XMLStreamWriter that writes to a JAXP result. This method is optional.

Parameters:

result - the result to write to

Throws:

java.lang.UnsupportedOperationException - if this method is not supported by this XMLOutputFactory

XMLStreamException

getProperty

public abstract java.lang.Object getProperty(java.lang.String name)
                                      throws java.lang.IllegalArgumentException

Get a feature/property on the underlying implementation

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

java.lang.IllegalArgumentException - if the property is not supported

isPropertySupported

public abstract boolean isPropertySupported(java.lang.String name)

Query the set of properties that this factory supports.

Parameters:

name - The name of the property (may not be null)

Returns:

true if the property is supported and false otherwise

newInstance

public static XMLOutputFactory newInstance()
                                    throws FactoryConfigurationError

Create a new instance of the factory.

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

newInstance

public static XMLInputFactory newInstance(java.lang.String factoryId,
                                          java.lang.ClassLoader classLoader)
                                   throws FactoryConfigurationError

Create a new instance of the factory

Parameters:

factoryId - Name of the factory to find, same as a property name

classLoader - classLoader to use

Returns:

the factory implementation

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

setProperty

public abstract void setProperty(java.lang.String name,
                                 java.lang.Object value)
                          throws java.lang.IllegalArgumentException

Allows the user to set specific features/properties on the underlying implementation.

Parameters:

name - The name of the property

value - The value of the property

Throws:

java.lang.IllegalArgumentException - if the property is not supported

public interface XMLReporter

This interface is used to report non-fatal errors. Only warnings should be echoed through this interface.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

report

void report(java.lang.String message,
            java.lang.String errorType,
            java.lang.Object relatedInformation,
            Location location)
            throws XMLStreamException

Report the desired message in an application specific format. Only warnings and non-fatal errors should be reported through this interface. Fatal errors should be thrown as XMLStreamException.

Parameters:

message - the error message

errorType - an implementation defined error type

relatedInformation - information related to the error, if available

location - the location of the error, if available

Throws:

XMLStreamException

public interface XMLResolver

This interface is used to resolve resources during an XML parse. If an application wishes to perform custom entity resolution it must register an instance of this interface with the XMLInputFactory using the setXMLResolver method.

Since:

6.0

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

resolveEntity

java.lang.Object resolveEntity(java.lang.String publicID,
                               java.lang.String systemID,
                               java.lang.String baseURI,
                               java.lang.String namespace)
                               throws XMLStreamException

Retrieves a resource. This resource can be of the following three return types: (1) java.io.InputStream (2) javax.xml.stream.XMLStreamReader (3) java.xml.stream.XMLEventReader. If this method returns null the processor will attempt to resolve the entity using its default mechanism.

Parameters:

publicID - The public identifier of the external entity being referenced, or null if none was supplied.

systemID - The system identifier of the external entity being referenced.

baseURI - Absolute base URI associated with systemId.

namespace - The namespace of the entity to resolve.

Returns:

The resource requested or null.

Throws:

XMLStreamException - if there was a failure attempting to resolve the resource.

public interface XMLStreamConstants

This interface declares the constants used in this API. Numbers in the range 0 to 256 are reserved for the specification, user defined events must use event codes outside that range.

Since:

6.0

ATTRIBUTE

static final int ATTRIBUTE

Indicates an event is an attribute

See Also:

Attribute, Constant Field Values

CDATA

static final int CDATA

Indicates an event is a CDATA section

See Also:

Characters, Constant Field Values

CHARACTERS

static final int CHARACTERS

Indicates an event is characters

See Also:

Characters, Constant Field Values

COMMENT

static final int COMMENT

Indicates an event is a comment

See Also:

Comment, Constant Field Values

DTD

static final int DTD

Indicates an event is a DTD

See Also:

DTD, Constant Field Values

END_DOCUMENT

static final int END_DOCUMENT

Indicates an event is an end document

See Also:

EndDocument, Constant Field Values

END_ELEMENT

static final int END_ELEMENT

Indicates an event is an end element

See Also:

EndElement, Constant Field Values