FileDocCategorySizeDatePackage
RequestingUserName.javaAPI DocJava SE 5 API4003Fri Aug 26 14:57:46 BST 2005javax.print.attribute.standard

RequestingUserName

public final class RequestingUserName extends TextSyntax implements PrintRequestAttribute
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 {@link JobOriginatingUserName 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

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public RequestingUserName(String userName, Locale locale)
Constructs a new requesting user name attribute with the given user name and locale.

param
userName User name.
param
locale Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
exception
NullPointerException (unchecked exception) Thrown if userName is null.


                                                                      
         
	super (userName, locale);
Methods Summary
public booleanequals(java.lang.Object object)
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.

param
object Object to compare to.
return
True if object is equivalent to this requesting user name attribute, false otherwise.

	return (super.equals(object) &&
		object instanceof RequestingUserName);
public final java.lang.ClassgetCategory()
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.

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return RequestingUserName.class;
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

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

return
Attribute category name.

	return "requesting-user-name";