Java example source code file (DatatypeFactoryImpl.java)

This example Java source code file (DatatypeFactoryImpl.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

bigdecimal, biginteger, datatypefactoryimpl, duration, durationdaytimeimpl, durationimpl, durationyearmonthimpl, math, nullpointerexception, override, string, trying, util, xmlgregoriancalendar, xmlgregoriancalendarimpl

The DatatypeFactoryImpl.java Java example source code

/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
/*
 * Copyright 2005 The Apache Software Foundation.
 *
 * Licensed 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;

/**
 * <p>Factory that creates new javax.xml.datatype Objects that map XML to/from Java Objects.

 *
 * <p id="DatatypeFactory.newInstance">{@link #newInstance()} is used to create a new DatatypeFactory.
 * The following implementation resolution mechanisms are used in the following order:</p>
 * <ol>
 *    <li>
 *      If the system property specified by {@link #DATATYPEFACTORY_PROPERTY}, "<code>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}.
 *    </li>
 *    <li>
 *      If the file ${JAVA_HOME}/lib/jaxp.properties exists, it is loaded in a {@link java.util.Properties} <code>Object.
 *      The <code>Properties Object  is then queried for the property as documented in the prior step
 *      and processed as documented in the prior step.
 *    </li>
 *    <li>
 *      The services resolution mechanism is used, e.g. <code>META-INF/services/java.xml.datatype.DatatypeFactory.
 *      Any Exception thrown during the instantiation process is wrapped as a {@link DatatypeConfigurationException}.
 *    </li>
 *    <li>
 *      The final mechanism is to attempt to instantiate the <code>Class specified by
 *      {@link #DATATYPEFACTORY_IMPLEMENTATION_CLASS}, "<code>javax.xml.datatype.DatatypeFactoryImpl".
 *      Any Exception thrown during the instantiation process is wrapped as a {@link DatatypeConfigurationException}.
 *    </li>
 * </ol>
 *
 * @author <a href="mailto:Joseph.Fialli@Sun.COM">Joseph Fialli
 * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor
 * @version $Id: DatatypeFactoryImpl.java,v 1.6 2010/05/19 05:02:55 joehw Exp $
 */
public class DatatypeFactoryImpl
        extends DatatypeFactory {

        /**
         * <p>Public constructor is empty..

         *
         * <p>Use {@link DatatypeFactory#newInstance()} to create a DatatypeFactory.

         */
        public DatatypeFactoryImpl() {
        }

        /**
         * <p>Obtain a new instance of a Duration
         * specifying the <code>Duration as its string representation, "PnYnMnDTnHnMnS",
         * as defined in XML Schema 1.0 section 3.2.6.1.</p>
         *
         * <p>XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration as:

         * <blockquote>
         * 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.
         * </blockquote>
     * <p>All six values are set and availabe from the created {@link Duration}

         *
     * <p>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.</p>
     *
         * @param lexicalRepresentation <code>String representation of a Duration.
         *
         * @return New <code>Duration created from parsing the lexicalRepresentation.
         *
         * @throws IllegalArgumentException If <code>lexicalRepresentation is not a valid representation of a Duration.
         * @throws UnsupportedOperationException If implementation cannot support requested values.
         * @throws NullPointerException if <code>lexicalRepresentation is null.
         */
        public Duration newDuration(final String lexicalRepresentation) {

                return new DurationImpl(lexicalRepresentation);
        }

        /**
         * <p>Obtain a new instance of a Duration
         * specifying the <code>Duration as milliseconds.

         *
         * <p>XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration as:

         * <blockquote>
         * 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.
         * </blockquote>
     * <p>All six values are set by computing their values from the specified milliseconds
     * and are availabe using the <code>get methods of  the created {@link Duration}.
     * The values conform to and are defined by:</p>
     * <ul>
     *   <li>ISO 8601:2000(E) Section 5.5.3.2 Alternative format
     *   <li>
     *     W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats</a>
     *   </li>
     *   <li>{@link XMLGregorianCalendar}  Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
     * </ul>
         *
         * <p>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.</p>
         *
         * @param durationInMilliseconds Duration in milliseconds to create.
         *
         * @return New <code>Duration representing durationInMilliseconds.
         */
        public Duration newDuration(final long durationInMilliseconds) {

                return new DurationImpl(durationInMilliseconds);
        }

        /**
         * <p>Obtain a new instance of a Duration
         * specifying the <code>Duration as isPositive, years, months, days, hours, minutes, seconds.

         *
     * <p>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.</p>
     *
         * @param isPositive Set to <code>false to create a negative duration. When the length
         *   of the duration is zero, this parameter will be ignored.
         * @param years of this <code>Duration
         * @param months of this <code>Duration
         * @param days of this <code>Duration
         * @param hours of this <code>Duration
         * @param minutes of this <code>Duration
         * @param seconds of this <code>Duration
         *
         * @return New <code>Duration created from the specified values.
         *
         * @throws IllegalArgumentException If values are not a valid representation of a <code>Duration.
         * @throws UnsupportedOperationException If implementation cannot support requested values.
         * @throws NullPointerException If any values are <code>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
                        );
                }
        /**
         * <p>Create a Duration of type xdt:yearMonthDuration using the specified
         * <code>year and month as defined in
         * <a href="http://www.w3.org/TR/xpath-datamodel#yearMonthDuration">
         *   XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration</a>.

         *
     * <p>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.</p>
     *
     * <p>A null value indicates that field is not set.

     *
     * @param isPositive Set to <code>false to create a negative duration. When the length
     *   of the duration is zero, this parameter will be ignored.
         * @param year Year of <code>Duration.
         * @param month Month of <code>Duration.
         *
         * @return New <code>Duration created using the specified year and month.
         *
         * @throws IllegalArgumentException If the values are not a valid representation of a
         * <code>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
                 );

        }
        /**
         * <p>Create a Duration of type xdt:yearMonthDuration using the specified
         * <code>year and month as defined in
         * <a href="http://www.w3.org/TR/xpath-datamodel#yearMonthDuration">
         *   XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration</a>.

         *
     * <p>A {@link DatatypeConstants#FIELD_UNDEFINED} value indicates that field is not set.

     *
     * @param isPositive Set to <code>false to create a negative duration. When the length
     *   of the duration is zero, this parameter will be ignored.
         * @param year Year of <code>Duration.
         * @param month Month of <code>Duration.
         *
         * @return New <code>Duration created using the specified year and month.
         *
         * @throws IllegalArgumentException If the values are not a valid representation of a
         * <code>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);
                }

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

         *
         * <p>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}.</p>
         *
     * <p>Both values are set and availabe from the created {@link Duration}

         *
     * <p>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.</p>
     *
         * @param lexicalRepresentation Lexical representation of a duration.
         *
         * @return New <code>Duration created using the specified lexicalRepresentation.
         *
         * @throws IllegalArgumentException If <code>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 <code>lexicalRepresentation is null.
         */
        public Duration newDurationYearMonth(
                final String lexicalRepresentation) {

                return new DurationYearMonthImpl(lexicalRepresentation);

        }
        /**
         * <p>Create a Duration of type xdt:yearMonthDuration using the specified milliseconds as defined in
         * <a href="http://www.w3.org/TR/xpath-datamodel#yearMonthDuration">
         *   XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration</a>.

         *
         * <p>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}.</p>
         *
     * <p>Both values are set by computing their values from the specified milliseconds
     * and are availabe using the <code>get methods of  the created {@link Duration}.
     * The values conform to and are defined by:</p>
     * <ul>
     *   <li>ISO 8601:2000(E) Section 5.5.3.2 Alternative format
     *   <li>
     *     W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats</a>
     *   </li>
     *   <li>{@link XMLGregorianCalendar}  Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
     * </ul>
     *
         * <p>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.</p>
         *
     * <p>Any remaining milliseconds after determining the year and month are discarded.

         *
         * @param durationInMilliseconds Milliseconds of <code>Duration to create.
         *
         * @return New <code>Duration created using the specified durationInMilliseconds.
         */
    public Duration newDurationYearMonth(
            final long durationInMilliseconds) {

        return new DurationYearMonthImpl(durationInMilliseconds);
    }

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

         *
         * <p>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 <code>http://www.w3.org/2003/11/xpath-datatypes.

         *
     * <p>All four values are set and availabe from the created {@link Duration}

         *
     * <p>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.</p>
     *
         * @param lexicalRepresentation Lexical representation of a duration.
         *
         * @return New <code>Duration created using the specified lexicalRepresentation.
         *
         * @throws IllegalArgumentException If <code>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 <code>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);
        }

        /**
         * <p>Create a Duration of type xdt:dayTimeDuration using the specified milliseconds as defined in
         * <a href="http://www.w3.org/TR/xpath-datamodel#dayTimeDuration">
         *   XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration</a>.

         *
         * <p>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 <code>http://www.w3.org/2003/11/xpath-datatypes.

         *
     * <p>All four values are set by computing their values from the specified milliseconds
     * and are availabe using the <code>get methods of  the created {@link Duration}.
     * The values conform to and are defined by:</p>
     * <ul>
     *   <li>ISO 8601:2000(E) Section 5.5.3.2 Alternative format
     *   <li>
     *     W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats</a>
     *   </li>
     *   <li>{@link XMLGregorianCalendar}  Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
     * </ul>
         *
         * <p>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.</p>
         *
     * <p>Any remaining milliseconds after determining the day, hour, minute and second are discarded.

     *
         * @param durationInMilliseconds Milliseconds of <code>Duration to create.
         *
         * @return New <code>Duration created with the specified durationInMilliseconds.
         *
         * @see <a href="http://www.w3.org/TR/xpath-datamodel#dayTimeDuration">
         *   XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration</a>
         */
        public Duration newDurationDayTime(final long durationInMilliseconds) {

                return new DurationDayTimeImpl(durationInMilliseconds);
        }

        /**
         * <p>Create a Duration of type xdt:dayTimeDuration using the specified
         * <code>day, hour, minute and second as defined in
         * <a href="http://www.w3.org/TR/xpath-datamodel#dayTimeDuration">
         *   XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration</a>.

         *
         * <p>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 <code>http://www.w3.org/2003/11/xpath-datatypes.

         *
     * <p>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.</p>
     *
     * <p>A null value indicates that field is not set.

     *
     * @param isPositive Set to <code>false to create a negative duration. When the length
     *   of the duration is zero, this parameter will be ignored.
         * @param day Day of <code>Duration.
         * @param hour Hour of <code>Duration.
         * @param minute Minute of <code>Duration.
         * @param second Second of <code>Duration.
         *
         * @return New <code>Duration created with the specified day, hour, minute
         * and <code>second.
         *
         * @throws IllegalArgumentException If the values are not a valid representation of a
         * <code>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
                );
        }

        /**
         * <p>Create a Duration of type xdt:dayTimeDuration using the specified
         * <code>day, hour, minute and second as defined in
         * <a href="http://www.w3.org/TR/xpath-datamodel#dayTimeDuration">
         *   XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration</a>.

         *
         * <p>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 <code>http://www.w3.org/2003/11/xpath-datatypes.

         *
     * <p>A {@link DatatypeConstants#FIELD_UNDEFINED} value indicates that field is not set.

     *
     * @param isPositive Set to <code>false to create a negative duration. When the length
     *   of the duration is zero, this parameter will be ignored.
         * @param day Day of <code>Duration.
         * @param hour Hour of <code>Duration.
         * @param minute Minute of <code>Duration.
         * @param second Second of <code>Duration.
         *
         * @return New <code>Duration created with the specified day, hour, minute
         * and <code>second.
         *
         * @throws IllegalArgumentException If the values are not a valid representation of a
         * <code>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
                                );
                }

        /**
         * <p>Create a new instance of an XMLGregorianCalendar.

         *
     * <p>All date/time datatype fields set to {@link DatatypeConstants#FIELD_UNDEFINED} or null.

     *
     * @return New <code>XMLGregorianCalendar with all date/time datatype fields set to
     *   {@link DatatypeConstants#FIELD_UNDEFINED} or null.
         */
        public XMLGregorianCalendar newXMLGregorianCalendar() {

                return new XMLGregorianCalendarImpl();
        }

        /**
         * <p>Create a new XMLGregorianCalendar by parsing the String as a lexical representation.

         *
     * <p>Parsing the lexical string representation is defined in
     * <a href="http://www.w3.org/TR/xmlschema-2/#dateTime-order">XML Schema 1.0 Part 2, Section 3.2.[7-14].1,
     * <em>Lexical Representation.

     *
     * <p>The string representation may not have any leading and trailing whitespaces.

     *
     * <p>The parsing is done field by field so that
     * the following holds for any lexically correct String x:</p>
     * <pre>
     * newXMLGregorianCalendar(x).toXMLFormat().equals(x)
     * </pre>
     * <p>Except for the noted lexical/canonical representation mismatches
     * listed in <a href="http://www.w3.org/2001/05/xmlschema-errata#e2-45">
     * XML Schema 1.0 errata, Section 3.2.7.2</a>.

         *
         * @param lexicalRepresentation Lexical representation of one the eight XML Schema date/time datatypes.
         *
         * @return <code>XMLGregorianCalendar created from the lexicalRepresentation.
         *
         * @throws IllegalArgumentException If the <code>lexicalRepresentation is not a valid XMLGregorianCalendar.
         * @throws NullPointerException If <code>lexicalRepresentation is null.
         */
        public XMLGregorianCalendar newXMLGregorianCalendar(final String lexicalRepresentation) {

                return new XMLGregorianCalendarImpl(lexicalRepresentation);
        }

        /**
         * <p>Create an XMLGregorianCalendar from a {@link GregorianCalendar}.

         *
         * <table border="2" rules="all" cellpadding="2">
         *   <thead>
         *     <tr>
         *       <th align="center" colspan="2">
         *          Field by Field Conversion from
         *          {@link GregorianCalendar} to an {@link XMLGregorianCalendar}
         *       </th>
         *     </tr>
         *     <tr>
         *        <th>java.util.GregorianCalendar field
         *        <th>javax.xml.datatype.XMLGregorianCalendar field
         *     </tr>
         *   </thead>
         *   <tbody>
         *     <tr>
         *       <td>ERA == GregorianCalendar.BC ? -YEAR : YEAR