DatatypeFactory
abstract class DatatypeFactory
kotlin.Any | |
↳ | javax.xml.datatype.DatatypeFactory |
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:
- 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 aDatatypeConfigurationException
. - If the file ${JAVA_HOME}/lib/jaxp.properties exists, it is loaded in a
java.util.Properties
Object
. TheProperties
Object
is then queried for the property as documented in the prior step and processed as documented in the prior step. - 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 aDatatypeConfigurationException
. - The final mechanism is to attempt to instantiate the
Class
specified byDATATYPEFACTORY_IMPLEMENTATION_CLASS
, "javax.xml.datatype.DatatypeFactoryImpl
". Any Exception thrown during the instantiation process is wrapped as aDatatypeConfigurationException
.
Note that you must supply your own implementation (such as Xerces); Android does not ship with a default implementation.
Summary
Constants | |
---|---|
static String |
Default property name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1. |
Protected constructors | |
---|---|
Protected constructor to prevent instantiation outside of package. |
Public methods | |
---|---|
open Duration! |
newDuration(isPositive: Boolean, years: Int, months: Int, days: Int, hours: Int, minutes: Int, seconds: Int) Obtain a new instance of a |
abstract Duration! |
newDuration(isPositive: Boolean, years: BigInteger!, months: BigInteger!, days: BigInteger!, hours: BigInteger!, minutes: BigInteger!, seconds: BigDecimal!) Obtain a new instance of a |
abstract Duration! |
newDuration(lexicalRepresentation: String!) Obtain a new instance of a |
abstract Duration! |
newDuration(durationInMilliSeconds: Long) Obtain a new instance of a |
open Duration! |
Create a |
open Duration! |
newDurationDayTime(isPositive: Boolean, day: BigInteger!, hour: BigInteger!, minute: BigInteger!, second: BigInteger!) Create a |
open Duration! |
newDurationDayTime(lexicalRepresentation: String!) Create a |
open Duration! |
newDurationDayTime(durationInMilliseconds: Long) Create a |
open Duration! |
newDurationYearMonth(isPositive: Boolean, year: Int, month: Int) Create a |
open Duration! |
newDurationYearMonth(isPositive: Boolean, year: BigInteger!, month: BigInteger!) Create a |
open Duration! |
newDurationYearMonth(lexicalRepresentation: String!) Create a |
open Duration! |
newDurationYearMonth(durationInMilliseconds: Long) Create a |
open static DatatypeFactory! |
Obtain a new instance of a |
open static DatatypeFactory! |
newInstance(factoryClassName: String!, classLoader: ClassLoader!) Returns an instance of the named implementation of |
abstract XMLGregorianCalendar! |
Create a new instance of an |
open XMLGregorianCalendar! |
newXMLGregorianCalendar(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Int, millisecond: Int, timezone: Int) Constructor of value spaces that a |
abstract XMLGregorianCalendar! |
newXMLGregorianCalendar(lexicalRepresentation: String!) Create a new XMLGregorianCalendar by parsing the String as a lexical representation. |
abstract XMLGregorianCalendar! |
newXMLGregorianCalendar(year: BigInteger!, month: Int, day: Int, hour: Int, minute: Int, second: Int, fractionalSecond: BigDecimal!, timezone: Int) Constructor allowing for complete value spaces allowed by W3C XML Schema 1. |
abstract XMLGregorianCalendar! |
Create an |
open XMLGregorianCalendar! |
newXMLGregorianCalendarDate(year: Int, month: Int, day: Int, timezone: Int) Create a Java representation of XML Schema builtin datatype |
open XMLGregorianCalendar! |
newXMLGregorianCalendarTime(hours: Int, minutes: Int, seconds: Int, timezone: Int) Create a Java instance of XML Schema builtin datatype |
open XMLGregorianCalendar! |
newXMLGregorianCalendarTime(hours: Int, minutes: Int, seconds: Int, milliseconds: Int, timezone: Int) Create a Java instance of XML Schema builtin datatype time. |
open XMLGregorianCalendar! |
newXMLGregorianCalendarTime(hours: Int, minutes: Int, seconds: Int, fractionalSecond: BigDecimal!, timezone: Int) Create a Java instance of XML Schema builtin datatype time. |
Properties | |
---|---|
static String! |
Default implementation class name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1. |
Constants
DATATYPEFACTORY_PROPERTY
static val DATATYPEFACTORY_PROPERTY: String
Default property name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1.3.
Default value is javax.xml.datatype.DatatypeFactory
.
Value: "javax.xml.datatype.DatatypeFactory"
Protected constructors
DatatypeFactory
protected DatatypeFactory()
Protected constructor to prevent instantiation outside of package.
Use newInstance()
to create a DatatypeFactory
.
Public methods
newDuration
open fun newDuration(
isPositive: Boolean,
years: Int,
months: Int,
days: Int,
hours: Int,
minutes: Int,
seconds: Int
): Duration!
Obtain a new instance of a Duration
specifying the Duration
as isPositive, years, months, days, hours, minutes, seconds.
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
isPositive |
Boolean: Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored. |
years |
Int: of this Duration |
months |
Int: of this Duration |
days |
Int: of this Duration |
hours |
Int: of this Duration |
minutes |
Int: of this Duration |
seconds |
Int: of this Duration |
Return | |
---|---|
Duration! |
New Duration created from the specified values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If values are not a valid representation of a Duration . |
newDuration
abstract fun newDuration(
isPositive: Boolean,
years: BigInteger!,
months: BigInteger!,
days: BigInteger!,
hours: BigInteger!,
minutes: BigInteger!,
seconds: BigDecimal!
): Duration!
Obtain a new instance of a Duration
specifying the Duration
as isPositive, years, months, days, hours, minutes, seconds.
The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded.
A null
value indicates that field is not set.
Parameters | |
---|---|
isPositive |
Boolean: Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored. |
years |
BigInteger!: of this Duration |
months |
BigInteger!: of this Duration |
days |
BigInteger!: of this Duration |
hours |
BigInteger!: of this Duration |
minutes |
BigInteger!: of this Duration |
seconds |
BigDecimal!: of this Duration |
Return | |
---|---|
Duration! |
New Duration created from the specified values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If values are not a valid representation of a Duration . |
java.lang.UnsupportedOperationException |
If implementation cannot support requested values. |
newDuration
abstract fun newDuration(lexicalRepresentation: String!): Duration!
Obtain a new instance of a Duration
specifying the Duration
as its string representation, "PnYnMnDTnHnMnS", as defined in XML Schema 1.0 section 3.2.6.1.
XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration
as:
All six values are set and available 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 |
String!: String representation of a Duration . |
Return | |
---|---|
Duration! |
New Duration created from parsing the lexicalRepresentation . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If lexicalRepresentation is not a valid representation of a Duration . |
java.lang.UnsupportedOperationException |
If implementation cannot support requested values. |
java.lang.NullPointerException |
if lexicalRepresentation is null . |
newDuration
abstract fun newDuration(durationInMilliSeconds: Long): Duration!
Obtain a new instance of a Duration
specifying the Duration
as milliseconds.
XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration
as:
All six values are set by computing their values from the specified milliseconds and are available using the get
methods of the created Duration
. The values conform to and are defined by:
- ISO 8601:2000(E) Section 5.5.3.2 Alternative format
- W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
XMLGregorianCalendar
Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
The default start instance is defined by GregorianCalendar
's use of the start of the epoch: i.e., java.util.Calendar#YEAR
= 1970, java.util.Calendar#MONTH
= java.util.Calendar#JANUARY
, java.util.Calendar#DATE
= 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month = java.util.Calendar#FEBRUARY
so the result of Duration.getMonths()
and Duration.getDays()
can be influenced.
Parameters | |
---|---|
durationInMilliSeconds |
Long: Duration in milliseconds to create. |
Return | |
---|---|
Duration! |
New Duration representing durationInMilliSeconds . |
newDurationDayTime
open fun newDurationDayTime(
isPositive: Boolean,
day: Int,
hour: Int,
minute: Int,
second: Int
): Duration!
Create a Duration
of type xdt:dayTimeDuration
using the specified day
, hour
, minute
and second
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.
The datatype xdt:dayTimeDuration
is a subtype of xs:duration
whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes
.
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
isPositive |
Boolean: Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored. |
day |
Int: Day of Duration . |
hour |
Int: Hour of Duration . |
minute |
Int: Minute of Duration . |
second |
Int: Second of Duration . |
Return | |
---|---|
Duration! |
New Duration created with the specified day , hour , minute and second . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any values would create an invalid Duration . |
newDurationDayTime
open fun newDurationDayTime(
isPositive: Boolean,
day: BigInteger!,
hour: BigInteger!,
minute: BigInteger!,
second: BigInteger!
): Duration!
Create a Duration
of type xdt:dayTimeDuration
using the specified day
, hour
, minute
and second
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.
The datatype xdt:dayTimeDuration
is a subtype of xs:duration
whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes
.
The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded.
A null
value indicates that field is not set.
Parameters | |
---|---|
isPositive |
Boolean: Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored. |
day |
BigInteger!: Day of Duration . |
hour |
BigInteger!: Hour of Duration . |
minute |
BigInteger!: Minute of Duration . |
second |
BigInteger!: Second of Duration . |
Return | |
---|---|
Duration! |
New Duration created with the specified day , hour , minute and second . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any values would create an invalid Duration . |
java.lang.UnsupportedOperationException |
If implementation cannot support requested values. |
newDurationDayTime
open fun newDurationDayTime(lexicalRepresentation: String!): Duration!
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 available 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 |
String!: Lexical representation of a duration. |
Return | |
---|---|
Duration! |
New Duration created using the specified lexicalRepresentation . |
Exceptions | |
---|---|
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
open fun newDurationDayTime(durationInMilliseconds: Long): Duration!
Create a Duration
of type xdt:dayTimeDuration
using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.
The datatype xdt:dayTimeDuration
is a subtype of xs:duration
whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes
.
All four values are set by computing their values from the specified milliseconds and are available using the get
methods of the created Duration
. The values conform to and are defined by:
- ISO 8601:2000(E) Section 5.5.3.2 Alternative format
- W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
XMLGregorianCalendar
Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
The default start instance is defined by GregorianCalendar
's use of the start of the epoch: i.e., java.util.Calendar#YEAR
= 1970, java.util.Calendar#MONTH
= java.util.Calendar#JANUARY
, java.util.Calendar#DATE
= 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month = java.util.Calendar#FEBRUARY
so the result of Duration.getDays()
can be influenced.
Any remaining milliseconds after determining the day, hour, minute and second are discarded.
Parameters | |
---|---|
durationInMilliseconds |
Long: Milliseconds of Duration to create. |
Return | |
---|---|
Duration! |
New Duration created with the specified durationInMilliseconds . |
See Also
newDurationYearMonth
open fun newDurationYearMonth(
isPositive: Boolean,
year: Int,
month: Int
): Duration!
Create a Duration
of type xdt:yearMonthDuration
using the specified year
and month
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
isPositive |
Boolean: Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored. |
year |
Int: Year of Duration . |
month |
Int: Month of Duration . |
Return | |
---|---|
Duration! |
New Duration created using the specified year and month . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any values would create an invalid Duration . |
newDurationYearMonth
open fun newDurationYearMonth(
isPositive: Boolean,
year: BigInteger!,
month: BigInteger!
): Duration!
Create a Duration
of type xdt:yearMonthDuration
using the specified year
and month
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.
The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. An UnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded.
A null
value indicates that field is not set.
Parameters | |
---|---|
isPositive |
Boolean: Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored. |
year |
BigInteger!: Year of Duration . |
month |
BigInteger!: Month of Duration . |
Return | |
---|---|
Duration! |
New Duration created using the specified year and month . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any values would create an invalid Duration . |
java.lang.UnsupportedOperationException |
If implementation cannot support requested values. |
newDurationYearMonth
open fun newDurationYearMonth(lexicalRepresentation: String!): Duration!
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 javax.xml.XMLConstants#W3C_XPATH_DATATYPE_NS_URI
.
Both values are set and available 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 |
String!: Lexical representation of a duration. |
Return | |
---|---|
Duration! |
New Duration created using the specified lexicalRepresentation . |
Exceptions | |
---|---|
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
open fun newDurationYearMonth(durationInMilliseconds: Long): Duration!
Create a Duration
of type xdt:yearMonthDuration
using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration.
The datatype xdt:yearMonthDuration
is a subtype of xs:duration
whose lexical representation contains only year and month components. This datatype resides in the namespace javax.xml.XMLConstants#W3C_XPATH_DATATYPE_NS_URI
.
Both values are set by computing their values from the specified milliseconds and are available using the get
methods of the created Duration
. The values conform to and are defined by:
- ISO 8601:2000(E) Section 5.5.3.2 Alternative format
- W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
XMLGregorianCalendar
Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
The default start instance is defined by GregorianCalendar
's use of the start of the epoch: i.e., java.util.Calendar#YEAR
= 1970, java.util.Calendar#MONTH
= java.util.Calendar#JANUARY
, java.util.Calendar#DATE
= 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month = java.util.Calendar#FEBRUARY
so the result of Duration.getMonths()
can be influenced.
Any remaining milliseconds after determining the year and month are discarded.
Parameters | |
---|---|
durationInMilliseconds |
Long: Milliseconds of Duration to create. |
Return | |
---|---|
Duration! |
New Duration created using the specified durationInMilliseconds . |
newInstance
open static fun newInstance(): DatatypeFactory!
Obtain a new instance of a DatatypeFactory
.
The implementation resolution mechanisms are defined in this Class
's documentation.
Note that you must supply your own implementation (such as Xerces); Android does not ship with a default implementation.
Return | |
---|---|
DatatypeFactory! |
New instance of a DocumentBuilderFactory |
Exceptions | |
---|---|
javax.xml.datatype.DatatypeConfigurationException |
If the implementation is not available or cannot be instantiated. |
newInstance
open static fun newInstance(
factoryClassName: String!,
classLoader: ClassLoader!
): DatatypeFactory!
Returns an instance of the named implementation of DatatypeFactory
.
Exceptions | |
---|---|
javax.xml.datatype.DatatypeConfigurationException |
if factoryClassName is not available or cannot be instantiated. |
newXMLGregorianCalendar
abstract fun newXMLGregorianCalendar(): XMLGregorianCalendar!
Create a new instance of an XMLGregorianCalendar
.
All date/time datatype fields set to DatatypeConstants.FIELD_UNDEFINED
or null.
Return | |
---|---|
XMLGregorianCalendar! |
New XMLGregorianCalendar with all date/time datatype fields set to DatatypeConstants.FIELD_UNDEFINED or null. |
newXMLGregorianCalendar
open fun newXMLGregorianCalendar(
year: Int,
month: Int,
day: Int,
hour: Int,
minute: Int,
second: Int,
millisecond: Int,
timezone: Int
): XMLGregorianCalendar!
Constructor of value spaces that a java.util.GregorianCalendar
instance would need to convert to an XMLGregorianCalendar
instance.
XMLGregorianCalendar eon
and fractionalSecond
are set to null
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
year |
Int: of XMLGregorianCalendar to be created. |
month |
Int: of XMLGregorianCalendar to be created. |
day |
Int: of XMLGregorianCalendar to be created. |
hour |
Int: of XMLGregorianCalendar to be created. |
minute |
Int: of XMLGregorianCalendar to be created. |
second |
Int: of XMLGregorianCalendar to be created. |
millisecond |
Int: of XMLGregorianCalendar to be created. |
timezone |
Int: of XMLGregorianCalendar to be created. |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from specified values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid() . |
newXMLGregorianCalendar
abstract fun newXMLGregorianCalendar(lexicalRepresentation: String!): XMLGregorianCalendar!
Create a new XMLGregorianCalendar by parsing the String as a lexical representation.
Parsing the lexical string representation is defined in XML Schema 1.0 Part 2, Section 3.2.[7-14].1, Lexical Representation.
The string representation may not have any leading and trailing whitespaces.
The parsing is done field by field so that the following holds for any lexically correct String x:
newXMLGregorianCalendar(x).toXMLFormat().equals(x)
Except for the noted lexical/canonical representation mismatches listed in XML Schema 1.0 errata, Section 3.2.7.2.
Parameters | |
---|---|
lexicalRepresentation |
String!: Lexical representation of one the eight XML Schema date/time datatypes. |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from the lexicalRepresentation . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If the lexicalRepresentation is not a valid XMLGregorianCalendar . |
java.lang.NullPointerException |
If lexicalRepresentation is null . |
newXMLGregorianCalendar
abstract fun newXMLGregorianCalendar(
year: BigInteger!,
month: Int,
day: Int,
hour: Int,
minute: Int,
second: Int,
fractionalSecond: BigDecimal!,
timezone: Int
): XMLGregorianCalendar!
Constructor allowing for complete value spaces allowed by W3C XML Schema 1.0 recommendation for xsd:dateTime and related builtin datatypes. Note that year
parameter supports arbitrarily large numbers and fractionalSecond has infinite precision.
A null
value indicates that field is not set.
Parameters | |
---|---|
year |
BigInteger!: of XMLGregorianCalendar to be created. |
month |
Int: of XMLGregorianCalendar to be created. |
day |
Int: of XMLGregorianCalendar to be created. |
hour |
Int: of XMLGregorianCalendar to be created. |
minute |
Int: of XMLGregorianCalendar to be created. |
second |
Int: of XMLGregorianCalendar to be created. |
fractionalSecond |
BigDecimal!: of XMLGregorianCalendar to be created. |
timezone |
Int: of XMLGregorianCalendar to be created. |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from specified values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid() . |
newXMLGregorianCalendar
abstract fun newXMLGregorianCalendar(cal: GregorianCalendar!): XMLGregorianCalendar!
Create an XMLGregorianCalendar
from a GregorianCalendar
.
Field by Field Conversion from GregorianCalendar to an XMLGregorianCalendar |
|
---|---|
java.util.GregorianCalendar field |
javax.xml.datatype.XMLGregorianCalendar field |
ERA == GregorianCalendar.BC ? -YEAR : YEAR |
XMLGregorianCalendar.setYear(int year) |
MONTH + 1 |
XMLGregorianCalendar.setMonth(int month) |
DAY_OF_MONTH |
XMLGregorianCalendar.setDay(int day) |
HOUR_OF_DAY, MINUTE, SECOND, MILLISECOND |
XMLGregorianCalendar.setTime(int hour, int minute, int second, BigDecimal fractional) |
(ZONE_OFFSET + DST_OFFSET) / (60*1000) (in minutes) |
XMLGregorianCalendar.setTimezone(int offset) * |
*conversion loss of information. It is not possible to represent a java.util.GregorianCalendar
daylight savings timezone id in the XML Schema 1.0 date/time datatype representation.
To compute the return value's TimeZone
field,
- when
this.getTimezone() != FIELD_UNDEFINED
, create ajava.util.TimeZone
with a custom timezone id using thethis.getTimezone()
. - else use the
GregorianCalendar
default timezone value for the host is defined as specified byjava.util.TimeZone.getDefault()
.
Parameters | |
---|---|
cal |
GregorianCalendar!: java.util.GregorianCalendar used to create XMLGregorianCalendar |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from java.util.GregorianCalendar |
Exceptions | |
---|---|
java.lang.NullPointerException |
If cal is null . |
newXMLGregorianCalendarDate
open fun newXMLGregorianCalendarDate(
year: Int,
month: Int,
day: Int,
timezone: Int
): XMLGregorianCalendar!
Create a Java representation of XML Schema builtin datatype date
or g*
.
For example, an instance of gYear
can be created invoking this factory with month
and day
parameters set to DatatypeConstants.FIELD_UNDEFINED
.
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
year |
Int: of XMLGregorianCalendar to be created. |
month |
Int: of XMLGregorianCalendar to be created. |
day |
Int: of XMLGregorianCalendar to be created. |
timezone |
Int: offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set. |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from parameter values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid() . |
newXMLGregorianCalendarTime
open fun newXMLGregorianCalendarTime(
hours: Int,
minutes: Int,
seconds: Int,
timezone: Int
): XMLGregorianCalendar!
Create a Java instance of XML Schema builtin datatype time
.
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
hours |
Int: number of hours |
minutes |
Int: number of minutes |
seconds |
Int: number of seconds |
timezone |
Int: offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set. |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from parameter values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid() . |
newXMLGregorianCalendarTime
open fun newXMLGregorianCalendarTime(
hours: Int,
minutes: Int,
seconds: Int,
milliseconds: Int,
timezone: Int
): XMLGregorianCalendar!
Create a Java instance of XML Schema builtin datatype time.
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
hours |
Int: number of hours |
minutes |
Int: number of minutes |
seconds |
Int: number of seconds |
milliseconds |
Int: number of milliseconds |
timezone |
Int: offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set. |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from parameter values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid() . |
newXMLGregorianCalendarTime
open fun newXMLGregorianCalendarTime(
hours: Int,
minutes: Int,
seconds: Int,
fractionalSecond: BigDecimal!,
timezone: Int
): XMLGregorianCalendar!
Create a Java instance of XML Schema builtin datatype time.
A null
value indicates that field is not set.
A DatatypeConstants.FIELD_UNDEFINED
value indicates that field is not set.
Parameters | |
---|---|
hours |
Int: number of hours |
minutes |
Int: number of minutes |
seconds |
Int: number of seconds |
fractionalSecond |
BigDecimal!: value of null indicates that this optional field is not set. |
timezone |
Int: offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set. |
Return | |
---|---|
XMLGregorianCalendar! |
XMLGregorianCalendar created from parameter values. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid() . |
Properties
DATATYPEFACTORY_IMPLEMENTATION_CLASS
static val DATATYPEFACTORY_IMPLEMENTATION_CLASS: String!
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
.