java.lang.Object
javax.print.attribute.TextSyntax
javax.print.attribute.standard.RequestingUserName
- All Implemented Interfaces:
- Serializable,- Cloneable,- Attribute,- PrintRequestAttribute
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:
- 
Constructor SummaryConstructorsConstructorDescriptionRequestingUserName(String userName, Locale locale) Constructs a new requesting user name attribute with the given user name and locale.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanReturns whether this requesting user name attribute is equivalent to the passed in object.Get the printing attribute class which is to be used as the "category" for this printing attribute value.final StringgetName()Get the name of the category of which this attribute value is an instance.Methods declared in class javax.print.attribute.TextSyntaxgetLocale, getValue, hashCode, toString
- 
Constructor Details- 
RequestingUserNameConstructs a new requesting user name attribute with the given user name and locale.- Parameters:
- userName- user name
- locale- natural language of the text string.- nullis interpreted to mean the default locale as returned by- Locale.getDefault()
- Throws:
- NullPointerException- if- userNameis- null
 
 
- 
- 
Method Details- 
equalsReturns whether this requesting user name attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:- objectis not- null.
- objectis 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.
 - Overrides:
- equalsin class- TextSyntax
- Parameters:
- object-- Objectto compare to
- Returns:
- trueif- objectis equivalent to this requesting user name attribute,- falseotherwise
- See Also:
 
- 
getCategoryGet the printing attribute class which is to be used as the "category" for this printing attribute value.For class RequestingUserName, the category is classRequestingUserNameitself.- Specified by:
- getCategoryin interface- Attribute
- Returns:
- printing attribute class (category), an instance of class
         java.lang.Class
 
- 
getNameGet the name of the category of which this attribute value is an instance.For class RequestingUserName, the category name is"requesting-user-name".
 
-