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
ConstructorsModifierConstructorDescriptionprotectedTextSyntax(String value, Locale locale) Constructs aTextAttributewith the specified string and locale. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns 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.inthashCode()Returns a hashcode for this text attribute.toString()Returns aStringidentifying this text attribute.
-
Constructor Details
-
TextSyntax
Constructs aTextAttributewith the specified string and locale.- Parameters:
value- text stringlocale- natural language of the text string.nullis interpreted to mean the default locale for as returned byLocale.getDefault()- Throws:
NullPointerException- ifvalueisnull
-
-
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:objectis notnull.objectis 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 aStringidentifying this text attribute. TheStringis the attribute's underlying text string.
-