FileDocCategorySizeDatePackage
DocumentName.javaAPI DocJava SE 5 API3522Fri Aug 26 14:57:44 BST 2005javax.print.attribute.standard

DocumentName

public final class DocumentName extends TextSyntax implements DocAttribute
Class DocumentName is a printing attribute class, a text attribute, that specifies the name of a document. DocumentName is an attribute of the print data (the doc), not of the Print Job. A document's name is an arbitrary string defined by the client. However if a JobName is not specified, the DocumentName should be used instead, which implies that supporting specification of DocumentName requires reporting of JobName and vice versa. See {@link JobName JobName} for more information.

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 DocumentName(String documentName, Locale locale)
Constructs a new document name attribute with the given document name and locale.

param
documentName Document 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 documentName is null.


                                                                       
         
	super (documentName, locale);
Methods Summary
public booleanequals(java.lang.Object object)
Returns whether this document 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 DocumentName.
  3. This document name attribute's underlying string and object's underlying string are equal.
  4. This document name attribute's locale and object's locale are equal.

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

	return (super.equals (object) && object instanceof DocumentName);
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 DocumentName, the category is class DocumentName itself.

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

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

For class DocumentName, the category name is "document-name".

return
Attribute category name.

	return "document-name";