OpenJDK 27 · javax.print.attribute.standard.JobOriginatingUserName

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 the RequestingUserName attribute supplied by the client in the Print Request's attribute set. If no authentication service is available, and the client did not supply a RequestingUserName attribute, 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.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides javax.print.attribute.TextSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

Access	Constructor and Description
public	JobOriginatingUserName(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 job originating user name attribute with the given user name and locale.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `object` is equivalent to this job originating user name attribute, `false` otherwise equals(Object `Object` to compare to object) Overrides javax.print.attribute.TextSyntax.equals. Returns whether this job originating 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:: getLocale getValue hashCode toString

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.print.attribute.TextSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

serialVersionUID

back 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

JobOriginatingUserName back to summary

JobOriginatingUserName	back to summary
public JobOriginatingUserName(String userName, Locale locale) Constructs a new job originating 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`

public JobOriginatingUserName(String userName, Locale locale)

Constructs a new job originating 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

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides javax.print.attribute.TextSyntax.equals. 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: `object` is not `null`. `object` is 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. Parameters object:Object `Object` to compare to Returns:boolean `true` if `object` is equivalent to this job originating user name attribute, `false` otherwise Annotations @Override

public boolean equals(Object object)

Overrides javax.print.attribute.TextSyntax.equals.

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:

object is not null.
object is 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.

Parameters

object:Object: Object to compare to

Returns:boolean

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

Annotations

@Override

getCategory back to summary

getCategory	back 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 `JobOriginatingUserName`, the category is class `JobOriginatingUserName` itself. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class` Annotations @Override

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 JobOriginatingUserName, the category is class JobOriginatingUserName itself.

Returns:Class<? extends Attribute>

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

Annotations

@Override

getName back to summary

getName	back 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 `JobOriginatingUserName`, the category name is `"job-originating-user-name"`. Returns:String attribute category name Annotations @Override

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 JobOriginatingUserName, the category name is "job-originating-user-name".

Returns:String

attribute category name

Annotations

@Override

public final Class JobOriginatingUserName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail