javax.xml.datatype

Class XMLGregorianCalendar

Implemented Interfaces:
Cloneable

public abstract class XMLGregorianCalendar
extends Object
implements Cloneable

An XML Schema 1.0 date/time data type.
Since:
1.3

Method Summary

abstract void
add(Duration duration)
Adds the specified duration to this calendar.
abstract void
clear()
Resets all fields to undefined.
abstract Object
clone()
This method may be called to create a new copy of the Object.
abstract int
compare(XMLGregorianCalendar xmlGregorianCalendar)
boolean
equals(Object obj)
Determine whether this Object is semantically equal to another Object.
abstract int
getDay()
abstract BigInteger
getEon()
abstract BigInteger
getEonAndYear()
abstract BigDecimal
getFractionalSecond()
abstract int
getHour()
int
getMillisecond()
abstract int
getMinute()
abstract int
getMonth()
abstract int
getSecond()
abstract TimeZone
getTimeZone(int defaultZoneoffset)
abstract int
getTimezone()
abstract QName
getXMLSchemaType()
abstract int
getYear()
int
hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.
abstract boolean
isValid()
Determines the validity of this calendar by getXMLSchemaType constraints.
abstract XMLGregorianCalendar
normalize()
abstract void
reset()
Resets all fields to their original values.
abstract void
setDay(int day)
abstract void
setFractionalSecond(BigDecimal fractional)
abstract void
setHour(int hour)
abstract void
setMillisecond(int millisecond)
abstract void
setMinute(int minute)
abstract void
setMonth(int month)
abstract void
setSecond(int second)
void
setTime(int hour, int minute, int second)
void
setTime(int hour, int minute, int second, int millisecond)
void
setTime(int hour, int minute, int second, BigDecimal fractional)
abstract void
setTimezone(int offset)
abstract void
setYear(int year)
abstract void
setYear(BigInteger year)
abstract GregorianCalendar
toGregorianCalendar()
abstract GregorianCalendar
toGregorianCalendar(TimeZone timezone, Locale locale, XMLGregorianCalendar defaults)
String
toString()
Convert this Object to a human-readable String.
abstract String
toXMLFormat()
Returns the XML Schema lexical representation of this calendar.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

add

public abstract void add(Duration duration)
Adds the specified duration to this calendar.

clear

public abstract void clear()
Resets all fields to undefined.

clone

public abstract Object clone()
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 
Overrides:
clone in interface Object
Returns:
a copy of the Object
See Also:
Cloneable

compare

public abstract int compare(XMLGregorianCalendar xmlGregorianCalendar)

equals

public boolean equals(Object obj)
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in interface Object
Parameters:
obj - the Object to compare to
Returns:
whether this Object is semantically equal to another

getDay

public abstract int getDay()

getEon

public abstract BigInteger getEon()

getEonAndYear

public abstract BigInteger getEonAndYear()

getFractionalSecond

public abstract BigDecimal getFractionalSecond()

getHour

public abstract int getHour()

getMillisecond

public int getMillisecond()

getMinute

public abstract int getMinute()

getMonth

public abstract int getMonth()

getSecond

public abstract int getSecond()

getTimeZone

public abstract TimeZone getTimeZone(int defaultZoneoffset)

getTimezone

public abstract int getTimezone()

getXMLSchemaType

public abstract QName getXMLSchemaType()

getYear

public abstract int getYear()

hashCode

public int hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in interface Object
Returns:
the hash code for this Object

isValid

public abstract boolean isValid()
Determines the validity of this calendar by getXMLSchemaType constraints.

normalize

public abstract XMLGregorianCalendar normalize()

reset

public abstract void reset()
Resets all fields to their original values.

setDay

public abstract void setDay(int day)

setFractionalSecond

public abstract void setFractionalSecond(BigDecimal fractional)

setHour

public abstract void setHour(int hour)

setMillisecond

public abstract void setMillisecond(int millisecond)

setMinute

public abstract void setMinute(int minute)

setMonth

public abstract void setMonth(int month)

setSecond

public abstract void setSecond(int second)

setTime

public void setTime(int hour,
                    int minute,
                    int second)

setTime

public void setTime(int hour,
                    int minute,
                    int second,
                    int millisecond)

setTime

public void setTime(int hour,
                    int minute,
                    int second,
                    BigDecimal fractional)

setTimezone

public abstract void setTimezone(int offset)

setYear

public abstract void setYear(int year)

setYear

public abstract void setYear(BigInteger year)

toGregorianCalendar

public abstract GregorianCalendar toGregorianCalendar()

toGregorianCalendar

public abstract GregorianCalendar toGregorianCalendar(TimeZone timezone,
                                                      Locale locale,
                                                      XMLGregorianCalendar defaults)

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface Object
Returns:
the String representing this Object, which may be null

toXMLFormat

public abstract String toXMLFormat()
Returns the XML Schema lexical representation of this calendar.

XMLGregorianCalendar.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.