This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.print.attribute.standard
class OutputDeviceAssigned

java.lang.Object extended by javax.print.attribute.TextSyntax extended by javax.print.attribute.standard.OutputDeviceAssigned
All Implemented Interfaces:
Serializable, Cloneable, PrintJobAttribute

public final class OutputDeviceAssigned
extends TextSyntax
implements PrintJobAttribute

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.


Constructor Summary
OutputDeviceAssigned(String deviceName, Locale locale)

          Constructs a new output device assigned attribute with the given device name and locale.
 
Method Summary
 boolean
equals(Object object)

          Returns whether this output device assigned attribute is equivalent to the passed in object.
 Class

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

          Get the name of the category of which this attribute value is an instance.
 
Methods inherited from class javax.print.attribute.TextSyntax
equals, getLocale, getValue, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputDeviceAssigned

public OutputDeviceAssigned(String deviceName,
                            Locale locale)
Constructs a new output device assigned attribute with the given device name and locale.

Parameters:
deviceName - Device name.
locale - Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
Method Detail

equals

public boolean equals(Object object)
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.

Overrides:
equals in class TextSyntax
Parameters:
object - Object to compare to.
Returns:
True if object is equivalent to this output device assigned attribute, false otherwise.

getCategory

public final Class 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:
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

getName

public final String 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:
Attribute category name.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.