| /* Copyright 2004 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 org.apache.xmlbeans; |
| |
| import java.util.Calendar; |
| import java.util.Date; |
| |
| |
| /** |
| * Corresponds to the XML Schema |
| * <a target="_blank" href="http://www.w3.org/TR/xmlschema-2/#dateTime">xs:dateTime</a> type. |
| * <p> |
| * Convertible to {@link Calendar}, {@link Date}, and {@link GDate}. |
| * |
| * <p> |
| * The XmlDateTime class only encapsulates a schema DateTime value, if you need to perform operations |
| * on dates, see the GDate class |
| * |
| * @see XmlCalendar |
| * @see GDate |
| * @see GDuration |
| */ |
| public interface XmlDateTime extends XmlAnySimpleType { |
| /** |
| * The constant {@link SchemaType} object representing this schema type. |
| */ |
| SchemaType type = XmlBeans.getBuiltinTypeSystem().typeForHandle("_BI_dateTime"); |
| |
| /** |
| * Returns this value as a {@link Calendar} |
| */ |
| Calendar getCalendarValue(); |
| |
| /** |
| * Sets this value as a {@link Calendar} |
| */ |
| void setCalendarValue(Calendar c); |
| |
| /** |
| * Returns this value as a {@link GDate} |
| */ |
| GDate getGDateValue(); |
| |
| /** |
| * Sets this value as a {@link GDateSpecification} |
| */ |
| void setGDateValue(GDate gd); |
| |
| /** |
| * Returns this value as a {@link Date} |
| */ |
| Date getDateValue(); |
| |
| /** |
| * Sets this value as a {@link Date} |
| */ |
| void setDateValue(Date d); |
| |
| /** |
| * A class with methods for creating instances |
| * of {@link XmlDateTime}. |
| */ |
| final class Factory { |
| /** |
| * Creates an empty instance of {@link XmlDateTime} |
| */ |
| public static XmlDateTime newInstance() { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().newInstance(type, null); |
| } |
| |
| /** |
| * Creates an empty instance of {@link XmlDateTime} |
| */ |
| public static XmlDateTime newInstance(org.apache.xmlbeans.XmlOptions options) { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().newInstance(type, options); |
| } |
| |
| /** |
| * Creates an immutable {@link XmlDateTime} value |
| */ |
| public static XmlDateTime newValue(Object obj) { |
| return (XmlDateTime) type.newValue(obj); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a String. For example: "<code><xml-fragment>2003-06-14T12:00:00</xml-fragment></code>". |
| */ |
| public static XmlDateTime parse(java.lang.String s) throws org.apache.xmlbeans.XmlException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(s, type, null); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a String. For example: "<code><xml-fragment>2003-06-14T12:00:00</xml-fragment></code>". |
| */ |
| public static XmlDateTime parse(java.lang.String s, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(s, type, options); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a File. |
| */ |
| public static XmlDateTime parse(java.io.File f) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(f, type, null); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a File. |
| */ |
| public static XmlDateTime parse(java.io.File f, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(f, type, options); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a URL. |
| */ |
| public static XmlDateTime parse(java.net.URL u) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(u, type, null); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a URL. |
| */ |
| public static XmlDateTime parse(java.net.URL u, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(u, type, options); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from an InputStream. |
| */ |
| public static XmlDateTime parse(java.io.InputStream is) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(is, type, null); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from an InputStream. |
| */ |
| public static XmlDateTime parse(java.io.InputStream is, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(is, type, options); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a Reader. |
| */ |
| public static XmlDateTime parse(java.io.Reader r) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(r, type, null); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a Reader. |
| */ |
| public static XmlDateTime parse(java.io.Reader r, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(r, type, options); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a DOM Node. |
| */ |
| public static XmlDateTime parse(org.w3c.dom.Node node) throws org.apache.xmlbeans.XmlException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(node, type, null); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from a DOM Node. |
| */ |
| public static XmlDateTime parse(org.w3c.dom.Node node, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(node, type, options); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from an XMLStreamReader. |
| */ |
| public static XmlDateTime parse(javax.xml.stream.XMLStreamReader xsr) throws org.apache.xmlbeans.XmlException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(xsr, type, null); |
| } |
| |
| /** |
| * Parses a {@link XmlDateTime} fragment from an XMLStreamReader. |
| */ |
| public static XmlDateTime parse(javax.xml.stream.XMLStreamReader xsr, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException { |
| return (XmlDateTime) XmlBeans.getContextTypeLoader().parse(xsr, type, options); |
| } |
| |
| private Factory() { |
| // No instance of this class allowed |
| } |
| } |
| } |
| |