com.sun.org.apache.xerces.internal.xs.datatypes.XSDateTime Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxp-ri Show documentation
Show all versions of jaxp-ri Show documentation
Java API for XML Processing Reference Implementation
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* 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.xs.datatypes;
import javax.xml.datatype.Duration;
import javax.xml.datatype.XMLGregorianCalendar;
/**
* Interface to expose the values for all date-time related types. The following
* table shows the methods defined for various XML Schema 1.0 built-in types. 'X'
* marks whether a particular method is defined for a particular type. Accessing undefined
* methods may return unexpected values.
*
*
*
*
* XML Schema Datatype
* getYears()
* getMonths()
* getDays()
* getHours()
* getMinutes()
* getSeconds()
* getTimeZoneHours()
* getTimeZoneMinutes()
* getXMLGregorianCalendar()
* getDuration()
* hasTimeZone()
* normalize()
* isNormalized()
* getLexicalValue()
*
*
* gYear
* X
* -
* -
* -
* -
* -
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* gMonth
* -
* X
* -
* -
* -
* -
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* gDay
* -
* -
* X
* -
* -
* -
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* gYearMonth
* X
* X
* -
* -
* -
* -
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* gMonthDay
* -
* X
* X
* -
* -
* -
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* date
* X
* X
* X
* -
* -
* -
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* time
* -
* -
* -
* X
* X
* X
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* datetime
* X
* X
* X
* X
* X
* X
* X
* X
* X
* -
* X
* X
* X
* X
*
*
* duration
* -
* X
* -
* -
* -
* X
* -
* -
* -
* X
* -
* -
* -
* X
*
*
*
*
* @author Ankit Pasricha, IBM
*
* @version $Id: XSDateTime.java,v 1.7 2010-11-01 04:40:31 joehw Exp $
*/
public interface XSDateTime {
/**
* @return years - can be negative for date-time related types;
*
*/
public int getYears();
/**
* @return months - can be negative only for duration types;
* For duration types, it returns years*12 + months
*/
public int getMonths();
/**
* @return days - cannot be negative;
*
*/
public int getDays();
/**
* @return hours - cannot be negative;
*
*/
public int getHours();
/**
* @return minutes - cannot be negative;
*
*/
public int getMinutes();
/**
* @return seconds - can be negative only for durations;
* For duration types, it returns days*24*3600 + hours*3600
* + minutes*60 + seconds
*/
public double getSeconds();
/**
* @return boolean (true when timezone is specified in the original lexical value)
*
*/
public boolean hasTimeZone();
/**
* @return timezone hours (for GMT-xx:xx this will be negative),
*
*/
public int getTimeZoneHours();
/**
* @return timezone minutes (for GMT-xx:xx this will be negative),
*
*/
public int getTimeZoneMinutes();
/**
* @return the original lexical value
*/
public String getLexicalValue();
/**
* @return a new date-time related object with normalized values
* (has no effect on objects already
* normalized)
*/
public XSDateTime normalize();
/**
* @return whether a date-time related object is normalized or not
* (value is not useful for types where timezone is not specified)
*/
public boolean isNormalized();
/**
* @return an un-normalized XMLGregorianCalendar (if applicable otherwise null)
*/
public XMLGregorianCalendar getXMLGregorianCalendar();
/**
* @return a Duration (if applicable otherwise null)
*/
public Duration getDuration();
}