javax.print.attribute.standard
Class JobOriginatingUserName
- java.lang.Object
-
- javax.print.attribute.TextSyntax
-
- javax.print.attribute.standard.JobOriginatingUserName
-
- All Implemented Interfaces:
- Serializable, Cloneable, Attribute, PrintJobAttribute
public final class JobOriginatingUserName extends TextSyntax implements PrintJobAttribute
Class JobOriginatingUserName is a printing attribute class, a text attribute, that contains the name of the end user that submitted the print job. If possible, the printer sets this attribute to the most authenticated printable user name that it can obtain from the authentication service that authenticated the submitted Print Request. If such is not available, the printer uses the value of theRequestingUserNameattribute supplied by the client in the Print Request's attribute set. If no authentication service is available, and the client did not supply aRequestingUserNameattribute, the printer sets the JobOriginatingUserName attribute to an empty (zero-length) string.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
Constructors Constructor and Description JobOriginatingUserName(String userName, Locale locale)Constructs a new job originating user name attribute with the given user name and locale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description booleanequals(Object object)Returns whether this job originating 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.StringgetName()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
-
-
-
-
Constructor Detail
JobOriginatingUserName
public JobOriginatingUserName(String userName, Locale locale)
Constructs a new job originating 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 byLocale.getDefault() - Throws:
-
NullPointerException- (unchecked exception) Thrown ifuserNameis null.
-
Method Detail
equals
public boolean equals(Object object)
Returns whether this job originating 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 JobOriginatingUserName.- This job originating user name attribute's underlying string and
object's underlying string are equal. - This job originating user name attribute's locale and
object's locale are equal.
- Overrides:
-
equalsin classTextSyntax - Parameters:
-
object- Object to compare to. - Returns:
-
True if
objectis equivalent to this job originating user name attribute, false otherwise. - See Also:
-
Object.hashCode(),HashMap
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 JobOriginatingUserName, the category is class JobOriginatingUserName itself.
- Specified by:
-
getCategoryin interfaceAttribute - Returns:
-
Printing attribute class (category), an instance of class
java.lang.Class.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
