Class TextSyntax
- java.lang.Object
-
- javax.print.attribute.TextSyntax
- All Implemented Interfaces:
-
Serializable
,Cloneable
- Direct Known Subclasses:
-
DocumentName
,JobMessageFromOperator
,JobName
,JobOriginatingUserName
,OutputDeviceAssigned
,PrinterInfo
,PrinterLocation
,PrinterMakeAndModel
,PrinterMessageFromOperator
,PrinterName
,RequestingUserName
public abstract class TextSyntax extends Object implements Serializable, Cloneable
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.
- See Also:
- Serialized Form
Constructor Summary
Modifier | Constructor | Description |
---|---|---|
protected | TextSyntax(String value,
Locale locale) | Constructs a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | equals(Object object) | Returns whether this text attribute is equivalent to the passed in object. |
Locale | getLocale() | Returns this text attribute's text string's natural language (locale). |
String | getValue() | Returns this text attribute's text string. |
int | hashCode() | Returns a hashcode for this text attribute. |
String | toString() | Returns a |
Methods declared in class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Constructor Detail
TextSyntax
protected TextSyntax(String value, Locale 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 byLocale.getDefault()
- Throws:
-
NullPointerException
- ifvalue
isnull
Method Detail
getValue
public String getValue()
Returns this text attribute's text string.
- Returns:
- the text string
getLocale
public Locale getLocale()
Returns this text attribute's text string's natural language (locale).
- Returns:
- the locale
hashCode
public int hashCode()
Returns a hashcode for this text attribute.
- Overrides:
-
hashCode
in classObject
- Returns:
- a hashcode value for this object
- See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
equals
public boolean equals(Object object)
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 notnull
. -
object
is an instance of classTextSyntax
. - This text attribute's underlying string and
object
's underlying string are equal. - This text attribute's locale and
object
's locale are equal.
- Overrides:
-
equals
in classObject
- Parameters:
-
object
-Object
to compare to - Returns:
-
true
ifobject
is equivalent to this text attribute,false
otherwise - See Also:
-
Object.hashCode()
,HashMap
toString
public String toString()
Returns a String
identifying this text attribute. The String
is the attribute's underlying text string.