Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class RequestingUserName

extends TextSyntax
implements PrintRequestAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintRequestAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, java.util.Locale, javax.print.attribute.Attribute, .PrintRequestAttribute, .TextSyntax
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.

Author
Alan Kaminsky

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
RequestingUserName(String
user name
userName, Locale
natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
locale)

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

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this requesting user name attribute, false otherwise
equals(Object
Object to compare to
object)

Overrides javax.print.attribute.TextSyntax.equals.

Returns whether this requesting user name attribute is equivalent to the passed in object.

public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory()

Implements javax.print.attribute.Attribute.getCategory.

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

public final String

Returns:

attribute category name
getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.TextSyntax:
getLocalegetValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

RequestingUserNameback to summary
public RequestingUserName(String userName, Locale locale)

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

Parameters
userName:String

user name

locale:Locale

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

Exceptions
NullPointerException:
if userName is null

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.TextSyntax.equals.

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:

  1. object is not null.
  2. object is an instance of class RequestingUserName.
  3. This requesting user name attribute's underlying string and object's underlying string are equal.
  4. This requesting user name attribute's locale and object's locale are equal.
Parameters
object:Object

Object to compare to

Returns:boolean

true if object is equivalent to this requesting user name attribute, false otherwise

getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.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.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.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".

Returns:String

attribute category name