Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class DateTimeAtCompleted

extends DateTimeSyntax
implements PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, java.util.Calendar, .Date, javax.print.attribute.Attribute, .DateTimeSyntax, .PrintJobAttribute

Class DateTimeAtCompleted is a printing attribute class, a date-time attribute, that indicates the date and time at which the Print Job completed (or was canceled or aborted).

To construct a DateTimeAtCompleted 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 DateTimeAtCompleted attribute. To convert a DateTimeAtCompleted 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 DateTimeAtCompleted attribute.

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

Author
Alan Kaminsky

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.DateTimeSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
DateTimeAtCompleted(Date
Date value
dateTime
)

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

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this date-time at completed attribute, false otherwise
equals
(Object
Object to compare to
object
)

Overrides javax.print.attribute.DateTimeSyntax.equals.

Returns whether this date-time at completed attribute is equivalent to the passed in object.

public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory
()

Implements javax.print.attribute.Attribute.getCategory.

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

public final String

Returns:

attribute category name
getName
()

Implements javax.print.attribute.Attribute.getName.

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

Inherited from javax.print.attribute.DateTimeSyntax:
getValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.DateTimeSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

DateTimeAtCompletedback to summary
public DateTimeAtCompleted(Date dateTime)

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

Parameters
dateTime:Date

Date value

Exceptions
NullPointerException:
if dateTime is null

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.DateTimeSyntax.equals.

Returns whether this date-time at completed 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 DateTimeAtCompleted.
  3. This date-time at completed attribute's Date value and object's Date value are equal.
Parameters
object:Object

Object to compare to

Returns:boolean

true if object is equivalent to this date-time at completed attribute, false otherwise

getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.getCategory.

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

For class DateTimeAtCompleted, the category is class DateTimeAtCompleted itself.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.getName.

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

For class DateTimeAtCompleted, the category name is "date-time-at-completed".

Returns:String

attribute category name