javax.print.attribute.standard

Class DocumentName

public final class DocumentName extends TextSyntax implements DocAttribute

The DocumentName printing attribute specifies a document name.

The document name may be different than the name of the job. It must not be unique across multiple documents in the same print job. Normally, an application provides the document name for the user by using e.g. the file name or a name generated automatically by the application.

IPP Compatibility: DocumentName is an IPP 1.1 attribute.

See Also:

Constructor Summary
DocumentName(String documentName, Locale locale)
Creates a DocumentName object.
Method Summary
booleanequals(Object obj)
Tests if the given object is equal to this object.
Class<? extends Attribute>getCategory()
Returns category of this class.
StringgetName()
Returns the name of this attribute.

Constructor Detail

DocumentName

public DocumentName(String documentName, Locale locale)
Creates a DocumentName object.

Parameters: documentName the document name locale the locale to use, if null the default locale is used.

Throws: NullPointerException if documentName is null

Method Detail

equals

public boolean equals(Object obj)
Tests if the given object is equal to this object.

Parameters: obj the object to test

Returns: true if both objects are equal, false otherwise.

getCategory

public Class<? extends Attribute> getCategory()
Returns category of this class.

Returns: The class DocumentName itself.

getName

public String getName()
Returns the name of this attribute.

Returns: The name "document-name".