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
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:
-
Constructor Summary
ModifierConstructorDescriptionprotected
TextSyntax
(String value, Locale locale) Constructs aTextAttribute
with the specified string and locale. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether this text attribute is equivalent to the passed in object.Returns this text attribute's text string's natural language (locale).getValue()
Returns this text attribute's text string.int
hashCode()
Returns a hashcode for this text attribute.toString()
Returns aString
identifying this text attribute.
-
Constructor Details
-
TextSyntax
Constructs aTextAttribute
with the specified string and locale.- Parameters:
value
- text stringlocale
- natural language of the text string.null
is interpreted to mean the default locale for as returned byLocale.getDefault()
- Throws:
NullPointerException
- ifvalue
isnull
-
-
Method Details
-
getValue
Returns this text attribute's text string.- Returns:
- the text string
-
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. -
equals
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.
-
toString
Returns aString
identifying this text attribute. TheString
is the attribute's underlying text string.
-