DateTimeAtCreation (Java 2 Platform SE 5.0) (original) (raw)

javax.print.attribute.standard

Class DateTimeAtCreation

java.lang.Object extended by javax.print.attribute.DateTimeSyntax javax.print.attribute.standard.DateTimeAtCreation

All Implemented Interfaces:

Serializable, Cloneable, Attribute, PrintJobAttribute

public final class DateTimeAtCreation

Class DateTimeAtCreation is a printing attribute class, a date-time attribute, that indicates the date and time at which the Print Job was created.

To construct a DateTimeAtCreation attribute from separate values of the year, month, day, hour, minute, and so on, use a Calendar object to construct a Date object, then use the Date object to construct the DateTimeAtCreation attribute. To convert a DateTimeAtCreation attribute to separate values of the year, month, day, hour, minute, and so on, create a Calendar object and set it to the Date from the DateTimeAtCreation attribute.

IPP Compatibility: The information needed to construct an IPP "date-time-at-creation" attribute can be obtained as described above. The category name returned by getName() gives the IPP attribute name.

See Also:

Serialized Form

Constructor Summary
DateTimeAtCreation(Date dateTime) Construct a new date-time at creation attribute with the given Date value.

Method Summary
boolean	equals(Object object) Returns whether this date-time at creation attribute is equivalent to the passed in object.
Class<? extends Attribute>	getCategory() Get the printing attribute class which is to be used as the "category" for this printing attribute value.
String	getName() Get the name of the category of which this attribute value is an instance.

Methods inherited from class javax.print.attribute.DateTimeSyntax
getValue, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

DateTimeAtCreation

public DateTimeAtCreation(Date dateTime)

Construct a new date-time at creation attribute with the given Date value.

Parameters:

dateTime - Date value.

Throws:

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - (unchecked exception) Thrown if dateTime is null.

Method Detail

equals

public boolean equals(Object object)

Returns whether this date-time at creation 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 DateTimeAtCreation.
This date-time at creation attribute's Date value and object's Date value are equal.

Overrides:

[equals](../../../../javax/print/attribute/DateTimeSyntax.html#equals%28java.lang.Object%29) in class [DateTimeSyntax](../../../../javax/print/attribute/DateTimeSyntax.html "class in javax.print.attribute")

Parameters:

object - Object to compare to.

Returns:

True if object is equivalent to this date-time at creation attribute, false otherwise.

See Also:

Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class DateTimeAtCreation, the category is class DateTimeAtCreation itself.

Specified by:

[getCategory](../../../../javax/print/attribute/Attribute.html#getCategory%28%29) in interface [Attribute](../../../../javax/print/attribute/Attribute.html "interface in javax.print.attribute")

Returns:

Printing attribute class (category), an instance of classjava.lang.Class.

getName

public final String getName()

Get the name of the category of which this attribute value is an instance.

For class DateTimeAtCreation, the category name is "date-time-at-creation".

Specified by:

[getName](../../../../javax/print/attribute/Attribute.html#getName%28%29) in interface [Attribute](../../../../javax/print/attribute/Attribute.html "interface in javax.print.attribute")

Returns:

Attribute category name.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.