|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.print.attribute.TextSyntax
javax.print.attribute.standard.RequestingUserName
public final class RequestingUserName
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.
| Constructor Summary | |
|---|---|
RequestingUserName(String userName,
Locale locale)
Constructs a new requesting user name attribute with the given user name and locale. |
|
| Method Summary | |
|---|---|
boolean |
equals(Object object)
Returns whether this requesting 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. |
String |
getName()
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 |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public RequestingUserName(String userName,
Locale locale)
userName - User name.locale - Natural language of the text string. null
is interpreted to mean the default locale as returned
by Locale.getDefault()
NullPointerException - (unchecked exception) Thrown if userName is null.| Method Detail |
|---|
public boolean equals(Object object)
object is not null.
object is an instance of class RequestingUserName.
object's underlying string are equal.
object's locale are equal.
equals in class TextSyntaxobject - Object to compare to.
object is equivalent to this requesting
user name attribute, false otherwise.Object.hashCode(),
Hashtablepublic final Class<? extends Attribute> getCategory()
For class RequestingUserName, the category is class RequestingUserName itself.
getCategory in interface Attributejava.lang.Class.public final String getName()
For class RequestingUserName, the
category name is "requesting-user-name".
getName in interface Attribute
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.