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

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

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

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

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 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

Constructor:

Constructor:
public DocumentName(String documentName, Locale locale) { super (documentName, locale); } Constructs a new document name attribute with the given document name and locale. Parameters: `documentName` - Document 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 `documentName` is null. exception: `NullPointerException` - (unchecked exception) Thrown if `documentName` is null.

 public DocumentName(String documentName,
    Locale locale) {
        super (documentName, locale);
}

Constructs a new document name attribute with the given document name and locale.

Parameters:

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

exception: NullPointerException - (unchecked exception) Thrown if documentName is null.

Method from javax.print.attribute.standard.DocumentName 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.DocumentName Detail:
public boolean equals(Object object) { return (super.equals (object) && object instanceof DocumentName); } Returns whether this document 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 DocumentName. This document name attribute's underlying string and `object`'s underlying string are equal. This document name attribute's locale and `object`'s locale are equal.
public final Class<Attribute> getCategory() { return DocumentName.class; } 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.
public final String getName() { return "document-name"; } Get the name of the category of which this attribute value is an instance. For class DocumentName, the category name is `"document-name"`.

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

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

object is not null.
object is an instance of class DocumentName.
This document name attribute's underlying string and object's underlying string are equal.
This document name attribute's locale and object's locale are equal.

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

For class DocumentName, the category is class DocumentName itself.

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

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