javax.print.attribute: abstract public class: DateTimeSyntax

javax.print.attribute
abstract public class: DateTimeSyntax [javadoc | source]

java.lang.Object
   javax.print.attribute.DateTimeSyntax

All Implemented Interfaces:
Cloneable, Serializable

Direct Known Subclasses:
DateTimeAtProcessing, DateTimeAtCreation, JobHoldUntil, DateTimeAtCompleted

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 getValue() . A date-time attribute's Date value is established when it is constructed (see 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

Constructor:

Constructor:
protected DateTimeSyntax(Date value) { // Hidden constructors. if (value == null) { throw new NullPointerException("value is null"); } this.value = value; } Construct a new date-time attribute with the given `java.util.Date` value. Parameters: `value` - `java.util.Date` value. Throws: `NullPointerException` - (unchecked exception) Thrown if `theValue` is null. exception: `NullPointerException` - (unchecked exception) Thrown if `theValue` is null.

 protected DateTimeSyntax(Date value) {
    // Hidden constructors.
        if (value == null) {
            throw new NullPointerException("value is null");
        }
        this.value = value;
}

java.util.Date

Parameters:

value - java.util.Date value.

Throws:

NullPointerException - (unchecked exception) Thrown if theValue is null.

exception: NullPointerException - (unchecked exception) Thrown if theValue is null.

Method from javax.print.attribute.DateTimeSyntax Summary:
equals, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.DateTimeSyntax Detail:
public boolean equals(Object object) { return (object != null && object instanceof DateTimeSyntax && value.equals(((DateTimeSyntax) object).value)); } Returns whether this date-time attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true: `object` is not null. `object` is an instance of class DateTimeSyntax. This date-time attribute's `java.util.Date` value and `object`'s `java.util.Date` value are equal.
public Date getValue() { return new Date (value.getTime()); } Returns this date-time attribute's `java.util.Date` value.
public int hashCode() { return value.hashCode(); } Returns a hash code value for this date-time attribute. The hashcode is that of this attribute's `java.util.Date` value.
public String toString() { return "" + value; } 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.

Method from javax.print.attribute.DateTimeSyntax Detail:

 public boolean equals(Object object) {
        return (object != null &&
                object instanceof DateTimeSyntax &&
                value.equals(((DateTimeSyntax) object).value));
}

object is not null.
object is an instance of class DateTimeSyntax.
This date-time attribute's java.util.Date value and object's java.util.Date value are equal.

 public Date getValue() {
        return new Date (value.getTime());
}

java.util.Date

 public int hashCode() {
        return value.hashCode();
}

java.util.Date

 public String toString() {
        return "" + value;
}

java.util.Date