javax.print.attribute: abstract public class: TextSyntax

javax.print.attribute
abstract public class: TextSyntax [javadoc | source]

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

All Implemented Interfaces:
Cloneable, Serializable

Direct Known Subclasses:
JobMessageFromOperator, PrinterMakeAndModel, JobName, OutputDeviceAssigned, PrinterName, PrinterLocation, RequestingUserName, DocumentName, JobOriginatingUserName, PrinterInfo, PrinterMessageFromOperator

Class TextSyntax is an abstract base class providing the common implementation of all attributes whose value is a string. The text attribute includes a locale to indicate the natural language. Thus, a text attribute always represents a localized string. Once constructed, a text attribute's value is immutable.

author: David - Mendenhall

author: Alan - Kaminsky

Constructor:

Constructor:
protected TextSyntax(String value, Locale locale) { this.value = verify (value); this.locale = verify (locale); } Constructs a TextAttribute with the specified string and locale. Parameters: `value` - Text string. `locale` - Natural language of the text string. null is interpreted to mean the default locale for as returned by `Locale.getDefault()` Throws: `NullPointerException` - (unchecked exception) Thrown if `value` is null. exception: `NullPointerException` - (unchecked exception) Thrown if `value` is null.

 protected TextSyntax(String value,
    Locale locale) {
                                                              
        this.value = verify (value);
        this.locale = verify (locale);
}

Constructs a TextAttribute with the specified string and locale.

Parameters:

value - Text string.

locale - Natural language of the text string. null is interpreted to mean the default locale for as returned by Locale.getDefault()

Throws:

NullPointerException - (unchecked exception) Thrown if value is null.

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

Method from javax.print.attribute.TextSyntax Summary:
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.TextSyntax Detail:
public boolean equals(Object object) { return(object != null && object instanceof TextSyntax && this.value.equals (((TextSyntax) object).value) && this.locale.equals (((TextSyntax) object).locale)); } Returns whether this text 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 TextSyntax. This text attribute's underlying string and `object`'s underlying string are equal. This text attribute's locale and `object`'s locale are equal.
public Locale getLocale() { return locale; } Returns this text attribute's text string's natural language (locale).
public String getValue() { return value; } Returns this text attribute's text string.
public int hashCode() { return value.hashCode() ^ locale.hashCode(); } Returns a hashcode for this text attribute.
public String toString() { return value; } Returns a String identifying this text attribute. The String is the attribute's underlying text string.

Method from javax.print.attribute.TextSyntax Detail:

 public boolean equals(Object object) {
        return(object != null &&
               object instanceof TextSyntax &&
               this.value.equals (((TextSyntax) object).value) &&
               this.locale.equals (((TextSyntax) object).locale));
}

object is not null.
object is an instance of class TextSyntax.
This text attribute's underlying string and object's underlying string are equal.
This text attribute's locale and object's locale are equal.

 public Locale getLocale() {
        return locale;
}

Returns this text attribute's text string's natural language (locale).

 public String getValue() {
        return value;
}

Returns this text attribute's text string.

 public int hashCode() {
        return value.hashCode() ^ locale.hashCode();
}

Returns a hashcode for this text attribute.

 public String toString() {
        return value;
}

Returns a String identifying this text attribute. The String is the attribute's underlying text string.