Summary: Protected Ctors | Methods | Inherited Methods | [Expand All]

public abstract class

TextSyntax

extends Object
implements Serializable Cloneable

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

Known Direct Subclasses

DocumentName, JobMessageFromOperator, JobName, JobOriginatingUserName, OutputDeviceAssigned, PrinterInfo, PrinterLocation, PrinterMakeAndModel, PrinterMessageFromOperator, PrinterName, RequestingUserName

DocumentName	Class DocumentName is a printing attribute class, a text attribute, that specifies the name of a document.
JobMessageFromOperator	Class JobMessageFromOperator is a printing attribute class, a text attribute, that provides a message from an operator, system administrator, or "intelligent" process to indicate to the end user the reasons for modification or other management action taken on a job.
JobName	Class JobName is a printing attribute class, a text attribute, that specifies the name of a print job.
JobOriginatingUserName	Class JobOriginatingUserName is a printing attribute class, a text attribute, that contains the name of the end user that submitted the print job.
OutputDeviceAssigned	Class OutputDeviceAssigned is a printing attribute class, a text attribute, that identifies the output device to which the service has assigned this job.
PrinterInfo	Class PrinterInfo is a printing attribute class, a text attribute, that provides descriptive information about a printer.
PrinterLocation	Class PrinterLocation is a printing attribute class, a text attribute, that identifies the location of the device.
PrinterMakeAndModel	Class PrinterMakeAndModel is a printing attribute class, a text attribute, that the make and model of the printer.
PrinterMessageFromOperator	Class PrinterMessageFromOperator is a printing attribute class, a text attribute, that provides a message from an operator, system administrator, or "intelligent" process to indicate to the end user information about or status of the printer, such as why it is unavailable or when it is expected to be available.
PrinterName	Class PrinterName is a printing attribute class, a text attribute, that specifies the name of a printer.
RequestingUserName	Class RequestingUserName is a printing attribute class, a text attribute, that specifies the name of the end user that submitted the print job.

Class Overview

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.

Summary

Protected Constructors
	TextSyntax(String value, Locale locale) Constructs a TextAttribute with the specified string and locale.

Public Methods
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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Protected Constructors

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	(unchecked exception) Thrown if `value` is null.

Public Methods

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 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.

Parameters

object	Object to compare to.

Returns

True if object is equivalent to this text attribute, false otherwise.

public Locale getLocale ()

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

Returns

the locale

public String getValue ()

Returns this text attribute's text string.

Returns

the text string.

public int hashCode ()

Returns a hashcode for this text attribute.

Returns

A hashcode value for this object.

public String toString ()

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

Returns

A String identifying this object.

Interfaces

Classes

Exceptions

TextSyntax

Class Overview

Summary

Protected Constructors

protected TextSyntax (String value, Locale locale)

Parameters

Throws

Public Methods

public boolean equals (Object object)

Parameters

Returns

public Locale getLocale ()

Returns

public String getValue ()

Returns

public int hashCode ()

Returns

public String toString ()

Returns