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:

Constructor Summary

TextSyntax(String value, Locale locale)
Modifier Constructor Description
protected
Constructs a TextAttribute with the specified string and locale.

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 String identifying this text attribute.

Methods declared in class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

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 by Locale.getDefault()
Throws:
NullPointerException - if value is null

Method Details

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 class Object
Returns:
a hashcode value for this object
See Also:

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:
  1. object is not null.
  2. object is an instance of class TextSyntax.
  3. This text attribute's underlying string and object's underlying string are equal.
  4. This text attribute's locale and object's locale are equal.
Overrides:
equals in class Object
Parameters:
object - Object to compare to
Returns:
true if object is equivalent to this text attribute, false otherwise
See Also:

toString

public String toString()
Returns a String identifying this text attribute. The String is the attribute's underlying text string.
Overrides:
toString in class Object
Returns:
a String identifying this object

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/print/attribute/TextSyntax.html