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

javax.print.attribute.standard

Class RequestingUserName

java.lang.Object extended by javax.print.attribute.TextSyntax javax.print.attribute.standard.RequestingUserName

All Implemented Interfaces:

Serializable, Cloneable, Attribute, PrintRequestAttribute

public final class RequestingUserName

Class RequestingUserName is a printing attribute class, a text attribute, that specifies the name of the end user that submitted the print job. A requesting user name is an arbitrary string defined by the client. The printer does not put the client-specified RequestingUserName attribute into the Print Job's attribute set; rather, the printer puts in a JobOriginatingUserName attribute. This means that services which support specifying a username with this attribute should also report a JobOriginatingUserName in the job's attribute set. Note that many print services may have a way to independently authenticate the user name, and so may state support for a requesting user name, but in practice will then report the user name authenticated by the service rather than that specified via this attribute.

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.

See Also:

Serialized Form

Constructor Summary
[RequestingUserName](../../../../javax/print/attribute/standard/RequestingUserName.html#RequestingUserName%28java.lang.String, java.util.Locale%29)(String userName,Locale locale) Constructs a new requesting user name attribute with the given user name and locale.

Method Summary
boolean	equals(Object object) Returns whether this requesting user name 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.TextSyntax
getLocale, 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

RequestingUserName

public RequestingUserName(String userName, Locale locale)

Constructs a new requesting user name attribute with the given user name and locale.

Parameters:

userName - User name.

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

Throws:

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

Method Detail

equals

public boolean equals(Object object)

Returns whether this requesting user name 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 RequestingUserName.
This requesting user name attribute's underlying string and object's underlying string are equal.
This requesting user name attribute's locale andobject's locale are equal.

Overrides:

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

Parameters:

object - Object to compare to.

Returns:

True if object is equivalent to this requesting user name 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 RequestingUserName, the category is class RequestingUserName 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 RequestingUserName, the category name is "requesting-user-name".

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.