APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class OutputDeviceAssigned

extends TextSyntax
implements PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, java.util.Locale, javax.print.attribute.Attribute, .PrintJobAttribute, .TextSyntax
Class OutputDeviceAssigned is a printing attribute class, a text attribute, that identifies the output device to which the service has assigned this job. If an output device implements an embedded Print Service instance, the printer need not set this attribute. If a print server implements a Print Service instance, the value may be empty (zero- length string) or not returned until the service assigns an output device to the job. This attribute is particularly useful when a single service supports multiple devices (so called "fan-out").

IPP Compatibility: The string value gives the IPP name value. The locale gives the IPP natural language. 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.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
OutputDeviceAssigned(String
device name
deviceName, Locale
natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
locale)

Constructs a new output device assigned attribute with the given device name and locale.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this output device assigned attribute, false otherwise
equals(Object
Object to compare to
object)

Overrides javax.print.attribute.TextSyntax.equals.

Returns whether this output device assigned 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.TextSyntax:
getLocalegetValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

OutputDeviceAssignedback to summary
public OutputDeviceAssigned(String deviceName, Locale locale)

Constructs a new output device assigned attribute with the given device name and locale.

Parameters
deviceName:String

device name

locale:Locale

natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()

Exceptions
NullPointerException:
if deviceName is null

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.TextSyntax.equals.

Returns whether this output device assigned 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 OutputDeviceAssigned.
  3. This output device assigned attribute's underlying string and object's underlying string are equal.
  4. This output device assigned attribute's locale and object's locale are equal.
Parameters
object:Object

Object to compare to

Returns:boolean

true if object is equivalent to this output device assigned attribute, false otherwise

Annotations
@Override
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 OutputDeviceAssigned, the category is class OutputDeviceAssigned itself.

Returns:Class<? extends Attribute>

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

Annotations
@Override
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 OutputDeviceAssigned, the category name is "output-device-assigned".

Returns:String

attribute category name

Annotations
@Override