FileDocCategorySizeDatePackage
DateTimeSyntax.javaAPI DocJava SE 6 API4183Tue Jun 10 00:26:22 BST 2008javax.print.attribute

DateTimeSyntax

public abstract class DateTimeSyntax extends Object implements Serializable, Cloneable
Class DateTimeSyntax is an abstract base class providing the common implementation of all attributes whose value is a date and time.

Under the hood, a date-time attribute is stored as a value of class java.util.Date. You can get a date-time attribute's Date value by calling {@link #getValue() getValue()}. A date-time attribute's Date value is established when it is constructed (see {@link #DateTimeSyntax(Date) DateTimeSyntax(Date)}). Once constructed, a date-time attribute's value is immutable.

To construct a date-time attribute from separate values of the year, month, day, hour, minute, and so on, use a java.util.Calendar object to construct a java.util.Date object, then use the java.util.Date object to construct the date-time attribute. To convert a date-time attribute to separate values of the year, month, day, hour, minute, and so on, create a java.util.Calendar object and set it to the java.util.Date from the date-time attribute. Class DateTimeSyntax stores its value in the form of a java.util.Date rather than a java.util.Calendar because it typically takes less memory to store and less time to compare a java.util.Date than a java.util.Calendar.

author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
private Date
value
This date-time attribute'sjava.util.Date value.
Constructors Summary
protected DateTimeSyntax(Date value)
Construct a new date-time attribute with the given java.util.Date value.

param
value java.util.Date value.
exception
NullPointerException (unchecked exception) Thrown if theValue is null.


    // Hidden constructors.

                                          
       
	if (value == null) {
	    throw new NullPointerException("value is null");
	}
	this.value = value;
Methods Summary
public booleanequals(java.lang.Object object)
Returns whether this date-time attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
  1. object is not null.
  2. object is an instance of class DateTimeSyntax.
  3. This date-time attribute's java.util.Date value and object's java.util.Date value are equal.

param
object Object to compare to.
return
True if object is equivalent to this date-time attribute, false otherwise.

	return (object != null &&
	        object instanceof DateTimeSyntax &&
		value.equals(((DateTimeSyntax) object).value));
public java.util.DategetValue()
Returns this date-time attribute's java.util.Date value.

return
the Date.

	return new Date (value.getTime());
public inthashCode()
Returns a hash code value for this date-time attribute. The hashcode is that of this attribute's java.util.Date value.

	return value.hashCode();
public java.lang.StringtoString()
Returns a string value corresponding to this date-time attribute. The string value is just this attribute's java.util.Date value converted to a string.

	return "" + value;