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

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

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

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

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

Constructor:

Constructor:
public RequestingUserName(String userName, Locale locale) { super (userName, locale); } Constructs a new requesting 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 RequestingUserName(String userName,
    Locale locale) {
        super (userName, locale);
}

Constructs a new requesting 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.RequestingUserName 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.RequestingUserName Detail:
public boolean equals(Object object) { return (super.equals(object) && object instanceof RequestingUserName); } 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: `object` is not null. `object` is 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.
public final Class<Attribute> getCategory() { return RequestingUserName.class; } 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.
public final String getName() { return "requesting-user-name"; } Get the name of the category of which this attribute value is an instance. For class RequestingUserName, the category name is `"requesting-user-name"`.

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

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

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

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

For class RequestingUserName, the category is class RequestingUserName itself.

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

For class RequestingUserName, the category name is "requesting-user-name".