/* * reserved comment block * DO NOT REMOVE OR ALTER! */ /* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.sun.org.apache.xerces.internal.jaxp.datatype; import java.math.BigInteger; import java.math.BigDecimal; import java.util.GregorianCalendar; import javax.xml.datatype.DatatypeConstants; import javax.xml.datatype.DatatypeFactory; import javax.xml.datatype.Duration; import javax.xml.datatype.XMLGregorianCalendar; /** *
Factory that creates new javax.xml.datatype
Object
s that map XML to/from Java Object
s.
{@link #newInstance()} is used to create a new DatatypeFactory
.
* The following implementation resolution mechanisms are used in the following order:
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 {@link DatatypeConfigurationException}.
* Object
.
* The Properties
Object
is then queried for the property as documented in the prior step
* and processed as documented in the prior step.
* META-INF/services/java.xml.datatype.DatatypeFactory
.
* Any Exception thrown during the instantiation process is wrapped as a {@link DatatypeConfigurationException}.
* Class
specified by
* {@link #DATATYPEFACTORY_IMPLEMENTATION_CLASS}, "javax.xml.datatype.DatatypeFactoryImpl
".
* Any Exception thrown during the instantiation process is wrapped as a {@link DatatypeConfigurationException}.
* Public constructor is empty..
* *Use {@link DatatypeFactory#newInstance()} to create a DatatypeFactory
.
Obtain a new instance of a Duration
* specifying the Duration
as its string representation, "PnYnMnDTnHnMnS",
* as defined in XML Schema 1.0 section 3.2.6.1.
XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration
as:
* duration represents a duration of time. * The value space of duration is a six-dimensional space where the coordinates designate the * Gregorian year, month, day, hour, minute, and second components defined in Section 5.5.3.2 of [ISO 8601], respectively. * These components are ordered in their significance by their order of appearance i.e. as * year, month, day, hour, minute, and second. **
All six values are set and availabe from the created {@link 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 {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits * if implementation capacities are exceeded.
* * @param lexicalRepresentationString
representation of a Duration
.
*
* @return New Duration
created from parsing the lexicalRepresentation
.
*
* @throws IllegalArgumentException If lexicalRepresentation
is not a valid representation of a Duration
.
* @throws UnsupportedOperationException If implementation cannot support requested values.
* @throws NullPointerException if lexicalRepresentation
is null
.
*/
public Duration newDuration(final String lexicalRepresentation) {
return new DurationImpl(lexicalRepresentation);
}
/**
* Obtain a new instance of a Duration
* specifying the Duration
as milliseconds.
XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration
as:
* duration represents a duration of time. * The value space of duration is a six-dimensional space where the coordinates designate the * Gregorian year, month, day, hour, minute, and second components defined in Section 5.5.3.2 of [ISO 8601], respectively. * These components are ordered in their significance by their order of appearance i.e. as * year, month, day, hour, minute, and second. **
All six values are set by computing their values from the specified milliseconds
* and are availabe using the get
methods of the created {@link Duration}.
* The values conform to and are defined by:
The default start instance is defined by {@link GregorianCalendar}'s use of the start of the epoch: i.e., * {@link java.util.Calendar#YEAR} = 1970, * {@link java.util.Calendar#MONTH} = {@link java.util.Calendar#JANUARY}, * {@link 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 = {@link java.util.Calendar#FEBRUARY} * so the result of {@link Duration#getMonths()} and {@link Duration#getDays()} can be influenced.
* * @param durationInMilliseconds Duration in milliseconds to create. * * @return NewDuration
representing durationInMilliseconds
.
*/
public Duration newDuration(final long durationInMilliseconds) {
return new DurationImpl(durationInMilliseconds);
}
/**
* 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 {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits * if implementation capacities are exceeded.
* * @param isPositive Set tofalse
to create a negative duration. When the length
* of the duration is zero, this parameter will be ignored.
* @param years of this Duration
* @param months of this Duration
* @param days of this Duration
* @param hours of this Duration
* @param minutes of this Duration
* @param seconds of this Duration
*
* @return New Duration
created from the specified values.
*
* @throws IllegalArgumentException If values are not a valid representation of a Duration
.
* @throws UnsupportedOperationException If implementation cannot support requested values.
* @throws NullPointerException If any values are null
.
*
* @see #newDuration(boolean isPositive, BigInteger years, BigInteger months, BigInteger days,
* BigInteger hours, BigInteger minutes, BigDecimal seconds)
*/
public Duration newDuration(
final boolean isPositive,
final BigInteger years,
final BigInteger months,
final BigInteger days,
final BigInteger hours,
final BigInteger minutes,
final BigDecimal seconds) {
return new DurationImpl(
isPositive,
years,
months,
days,
hours,
minutes,
seconds
);
}
/**
* 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 {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits * if implementation capacities are exceeded.
* *A null
value indicates that field is not set.
false
to create a negative duration. When the length
* of the duration is zero, this parameter will be ignored.
* @param year Year of Duration
.
* @param month Month of Duration
.
*
* @return New Duration
created using the specified year
and month
.
*
* @throws IllegalArgumentException If the values are not a valid representation of a
* Duration
: if all of the fields (year, month) are null or
* if any of the fields is negative.
* @throws UnsupportedOperationException If implementation cannot support requested values.
*/
public Duration newDurationYearMonth(
final boolean isPositive,
final BigInteger year,
final BigInteger month) {
return new DurationYearMonthImpl(
isPositive,
year,
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 {@link DatatypeConstants#FIELD_UNDEFINED} value indicates that field is not set.
* * @param isPositive Set tofalse
to create a negative duration. When the length
* of the duration is zero, this parameter will be ignored.
* @param year Year of Duration
.
* @param month Month of Duration
.
*
* @return New Duration
created using the specified year
and month
.
*
* @throws IllegalArgumentException If the values are not a valid representation of a
* Duration
: if any of the fields (year, month) is negative.
*/
@Override
public Duration newDurationYearMonth(
final boolean isPositive,
final int year,
final int month) {
return new DurationYearMonthImpl(
isPositive,
year,
month);
}
/**
* 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 {@link javax.xml.XMLConstants#W3C_XPATH_DATATYPE_NS_URI}.
Both values are set and availabe from the created {@link 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 {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits * if implementation capacities are exceeded.
* * @param lexicalRepresentation Lexical representation of a duration. * * @return NewDuration
created using the specified lexicalRepresentation
.
*
* @throws IllegalArgumentException If lexicalRepresentation
is not a valid representation of a Duration
expressed only in terms of years and months.
* @throws UnsupportedOperationException If implementation cannot support requested values.
* @throws NullPointerException If lexicalRepresentation
is null
.
*/
public Duration newDurationYearMonth(
final String lexicalRepresentation) {
return new DurationYearMonthImpl(lexicalRepresentation);
}
/**
* 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 {@link javax.xml.XMLConstants#W3C_XPATH_DATATYPE_NS_URI}.
Both values are set by computing their values from the specified milliseconds
* and are availabe using the get
methods of the created {@link Duration}.
* The values conform to and are defined by:
The default start instance is defined by {@link GregorianCalendar}'s use of the start of the epoch: i.e., * {@link java.util.Calendar#YEAR} = 1970, * {@link java.util.Calendar#MONTH} = {@link java.util.Calendar#JANUARY}, * {@link 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 = {@link java.util.Calendar#FEBRUARY} * so the result of {@link Duration#getMonths()} can be influenced.
* *Any remaining milliseconds after determining the year and month are discarded.
* * @param durationInMilliseconds Milliseconds ofDuration
to create.
*
* @return New Duration
created using the specified durationInMilliseconds
.
*/
public Duration newDurationYearMonth(
final long durationInMilliseconds) {
return new DurationYearMonthImpl(durationInMilliseconds);
}
/**
* 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 {@link 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 {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits * if implementation capacities are exceeded.
* * @param lexicalRepresentation Lexical representation of a duration. * * @return NewDuration
created using the specified lexicalRepresentation
.
*
* @throws IllegalArgumentException If lexicalRepresentation
is not a valid representation of a Duration
expressed only in terms of days and time.
* @throws UnsupportedOperationException If implementation cannot support requested values.
* @throws NullPointerException If lexicalRepresentation
is null
.
*/
public Duration newDurationDayTime(final String lexicalRepresentation) {
// lexicalRepresentation must be non-null
if (lexicalRepresentation == null) {
throw new NullPointerException(
"Trying to create an xdt:dayTimeDuration with an invalid"
+ " lexical representation of \"null\"");
}
return new DurationDayTimeImpl(lexicalRepresentation);
}
/**
* Create a Duration
of type xdt:dayTimeDuration
using the specified milliseconds as defined in
*
* XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.
The datatype xdt:dayTimeDuration
is a subtype of xs:duration
* whose lexical representation contains only day, hour, minute, and second components.
* This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes
.
All four values are set by computing their values from the specified milliseconds
* and are availabe using the get
methods of the created {@link Duration}.
* The values conform to and are defined by:
The default start instance is defined by {@link GregorianCalendar}'s use of the start of the epoch: i.e., * {@link java.util.Calendar#YEAR} = 1970, * {@link java.util.Calendar#MONTH} = {@link java.util.Calendar#JANUARY}, * {@link 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 = {@link java.util.Calendar#FEBRUARY} * so the result of {@link Duration#getDays()} can be influenced.
* *Any remaining milliseconds after determining the day, hour, minute and second are discarded.
* * @param durationInMilliseconds Milliseconds ofDuration
to create.
*
* @return New Duration
created with the specified durationInMilliseconds
.
*
* @see
* XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration
*/
public Duration newDurationDayTime(final long durationInMilliseconds) {
return new DurationDayTimeImpl(durationInMilliseconds);
}
/**
* 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 {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits * if implementation capacities are exceeded.
* *A null
value indicates that field is not set.
false
to create a negative duration. When the length
* of the duration is zero, this parameter will be ignored.
* @param day Day of Duration
.
* @param hour Hour of Duration
.
* @param minute Minute of Duration
.
* @param second Second of Duration
.
*
* @return New Duration
created with the specified day
, hour
, minute
* and second
.
*
* @throws IllegalArgumentException If the values are not a valid representation of a
* Duration
: if all the fields (day, hour, ...) are null or
* if any of the fields is negative.
* @throws UnsupportedOperationException If implementation cannot support requested values.
*/
public Duration newDurationDayTime(
final boolean isPositive,
final BigInteger day,
final BigInteger hour,
final BigInteger minute,
final BigInteger second) {
return new DurationDayTimeImpl(
isPositive,
day,
hour,
minute,
(second != null)? new BigDecimal(second):null
);
}
/**
* Create a Duration
of type xdt:dayTimeDuration
using the specified
* day
, hour
, minute
and second
as defined in
*
* XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration.
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 {@link DatatypeConstants#FIELD_UNDEFINED} value indicates that field is not set.
* * @param isPositive Set tofalse
to create a negative duration. When the length
* of the duration is zero, this parameter will be ignored.
* @param day Day of Duration
.
* @param hour Hour of Duration
.
* @param minute Minute of Duration
.
* @param second Second of Duration
.
*
* @return New Duration
created with the specified day
, hour
, minute
* and second
.
*
* @throws IllegalArgumentException If the values are not a valid representation of a
* Duration
: if any of the fields (day, hour, ...) is negative.
*/
public Duration newDurationDayTime(
final boolean isPositive,
final int day,
final int hour,
final int minute,
final int second) {
return new DurationDayTimeImpl(
isPositive,
day,
hour,
minute,
second
);
}
/**
* Create a new instance of an XMLGregorianCalendar
.
All date/time datatype fields set to {@link DatatypeConstants#FIELD_UNDEFINED} or null.
* * @return NewXMLGregorianCalendar
with all date/time datatype fields set to
* {@link DatatypeConstants#FIELD_UNDEFINED} or null.
*/
public XMLGregorianCalendar newXMLGregorianCalendar() {
return new XMLGregorianCalendarImpl();
}
/**
* 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.
* * @param lexicalRepresentation Lexical representation of one the eight XML Schema date/time datatypes. * * @returnXMLGregorianCalendar
created from the lexicalRepresentation
.
*
* @throws IllegalArgumentException If the lexicalRepresentation
is not a valid XMLGregorianCalendar
.
* @throws NullPointerException If lexicalRepresentation
is null
.
*/
public XMLGregorianCalendar newXMLGregorianCalendar(final String lexicalRepresentation) {
return new XMLGregorianCalendarImpl(lexicalRepresentation);
}
/**
* Create an XMLGregorianCalendar
from a {@link GregorianCalendar}.
* Field by Field Conversion from * {@link GregorianCalendar} to an {@link XMLGregorianCalendar} * | *|
---|---|
java.util.GregorianCalendar field |
* javax.xml.datatype.XMLGregorianCalendar field |
*
ERA == GregorianCalendar.BC ? -YEAR : YEAR |
* {@link XMLGregorianCalendar#setYear(int year)} | *
MONTH + 1 |
* {@link XMLGregorianCalendar#setMonth(int month)} | *
DAY_OF_MONTH |
* {@link XMLGregorianCalendar#setDay(int day)} | *
HOUR_OF_DAY, MINUTE, SECOND, MILLISECOND |
* {@link XMLGregorianCalendar#setTime(int hour, int minute, int second, BigDecimal fractional)} | *
* (ZONE_OFFSET + DST_OFFSET) / (60*1000) * (in minutes) * |
* {@link 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,
*
this.getTimezone() != FIELD_UNDEFINED
,
* create a java.util.TimeZone
with a custom timezone id
* using the this.getTimezone()
.GregorianCalendar
default timezone value
* for the host is defined as specified by
* java.util.TimeZone.getDefault()
.java.util.GregorianCalendar
used to create XMLGregorianCalendar
*
* @return XMLGregorianCalendar
created from java.util.GregorianCalendar
*
* @throws NullPointerException If cal
is null
.
*/
public XMLGregorianCalendar newXMLGregorianCalendar(final GregorianCalendar cal) {
return new XMLGregorianCalendarImpl(cal);
}
/**
* 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.
XMLGregorianCalendar
to be created.
* @param month of XMLGregorianCalendar
to be created.
* @param day of XMLGregorianCalendar
to be created.
* @param hour of XMLGregorianCalendar
to be created.
* @param minute of XMLGregorianCalendar
to be created.
* @param second of XMLGregorianCalendar
to be created.
* @param fractionalSecond of XMLGregorianCalendar
to be created.
* @param timezone of XMLGregorianCalendar
to be created.
*
* @return XMLGregorianCalendar
created from specified values.
*
* @throws IllegalArgumentException If any individual parameter's value is outside the maximum value constraint for the field
* as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar}
* or if the composite values constitute an invalid XMLGregorianCalendar
instance
* as determined by {@link XMLGregorianCalendar#isValid()}.
* @throws NullPointerException If any parameters are null
.
*
*/
public XMLGregorianCalendar newXMLGregorianCalendar(
final BigInteger year,
final int month,
final int day,
final int hour,
final int minute,
final int second,
final BigDecimal fractionalSecond,
final int timezone) {
return new XMLGregorianCalendarImpl(
year,
month,
day,
hour,
minute,
second,
fractionalSecond,
timezone
);
}
}