javax.print.attribute.standard: public final class: JobOriginatingUserName

javax.print.attribute.standard
public final class: JobOriginatingUserName [javadoc | source]

java.lang.Object
   javax.print.attribute.TextSyntax
      javax.print.attribute.standard.JobOriginatingUserName

All Implemented Interfaces:
PrintJobAttribute, Cloneable, java$io$Serializable

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.

author: Alan - Kaminsky

Constructor:

Constructor:
public JobOriginatingUserName(String userName, Locale locale) { super (userName, 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 by `Locale.getDefault()` Throws: `NullPointerException` - (unchecked exception) Thrown if `userName` is null. exception: `NullPointerException` - (unchecked exception) Thrown if `userName` is null.

 public JobOriginatingUserName(String userName,
    Locale locale) {
        super (userName, 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 by Locale.getDefault()

Throws:

NullPointerException - (unchecked exception) Thrown if userName is null.

exception: NullPointerException - (unchecked exception) Thrown if userName is null.

Method from javax.print.attribute.standard.JobOriginatingUserName Summary:
equals, getCategory, getName

Methods from javax.print.attribute.TextSyntax:
equals, getLocale, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.standard.JobOriginatingUserName Detail:
public boolean equals(Object object) { return (super.equals (object) && object instanceof JobOriginatingUserName); } 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.
public final Class<Attribute> getCategory() { return JobOriginatingUserName.class; } 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.
public final String getName() { return "job-originating-user-name"; } 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"`.

Method from javax.print.attribute.standard.JobOriginatingUserName Detail:

 public boolean equals(Object object) {
        return (super.equals (object) &&
                object instanceof JobOriginatingUserName);
}

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.

 public final Class<Attribute> getCategory() {
        return JobOriginatingUserName.class;
}

For class JobOriginatingUserName, the category is class JobOriginatingUserName itself.

 public final String getName() {
        return "job-originating-user-name";
}

For class JobOriginatingUserName, the category name is "job-originating-user-name".