| |
|
| java.lang.Object javax.print.attribute.TextSyntax javax.print.attribute.standard.RequestingUserName
RequestingUserName | final public class RequestingUserName extends TextSyntax implements PrintRequestAttribute(Code) | | 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 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.
author: Alan Kaminsky |
Constructor Summary | |
public | RequestingUserName(String userName, Locale locale) Constructs a new requesting user name attribute with the given user
name and locale. |
Method Summary | |
public boolean | equals(Object object) Returns whether this requesting user name attribute is equivalent to
the passed in object. | final public 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. | final public String | getName() Get the name of the category of which this attribute value is an
instance. |
RequestingUserName | public RequestingUserName(String userName, Locale locale)(Code) | | Constructs a new requesting user name attribute with the given user
name and locale.
Parameters: userName - User name. Parameters: locale - Natural language of the text string. nullis interpreted to mean the default locale as returnedby Locale.getDefault() exception: NullPointerException - (unchecked exception) Thrown if userName is null. |
equals | public boolean equals(Object object)(Code) | | 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 and
object 's locale are equal.
Parameters: object - Object to compare to. True if object is equivalent to this requestinguser name attribute, false otherwise. |
getCategory | final public Class<? extends Attribute> getCategory()(Code) | | 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.
Printing attribute class (category), an instance of classjava.lang.Class java.lang.Class. |
getName | final public String getName()(Code) | | Get the name of the category of which this attribute value is an
instance.
For class RequestingUserName, the
category name is "requesting-user-name" .
Attribute category name. |
|
|
|