OpenJDK 1.23 · javax.print.attribute.standard.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.

A Print Service's attribute set includes zero instances or one instance of a PrinterMessageFromOperator attribute, not more than one instance. A new PrinterMessageFromOperator attribute replaces an existing PrinterMessageFromOperator attribute, if any. In other words, PrinterMessageFromOperator is not intended to be a history log. If it wishes, the client can detect changes to a Print Service's PrinterMessageFromOperator attribute and maintain the client's own history log of the PrinterMessageFromOperator attribute values.

IPP Compatibility: The string value gives the IPP name value. The locale gives the IPP natural language. The category name returned by getName() gives the IPP attribute name.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides javax.print.attribute.TextSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

Access	Constructor and Description
public	PrinterMessageFromOperator(String the message message, Locale natural language of the text string. `null` is interpreted to mean the default locale as returned by `Locale.getDefault()` locale) Constructs a new printer message from operator attribute with the given message and locale.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `object` is equivalent to this printer message from operator attribute, `false` otherwise equals(Object `Object` to compare to object) Overrides javax.print.attribute.TextSyntax.equals. Returns whether this printer message from operator attribute is equivalent to the passed in object.
public final Class<? extends Attribute>	Returns: printing attribute class (category), an instance of class `java.lang.Class` getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value.
public final String	Returns: attribute category name getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.TextSyntax:: getLocale getValue hashCode toString

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.print.attribute.TextSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations

@Serial

Constructor Detail

PrinterMessageFromOperator back to summary

PrinterMessageFromOperator	back to summary
public PrinterMessageFromOperator(String message, Locale locale) Constructs a new printer message from operator attribute with the given message and locale. Parameters message:String the message locale:Locale natural language of the text string. `null` is interpreted to mean the default locale as returned by `Locale.getDefault()` Exceptions NullPointerException: if `message` is `null`

public PrinterMessageFromOperator(String message, Locale locale)

Constructs a new printer message from operator attribute with the given message and locale.

Parameters

message:String: the message
locale:Locale: natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()

Exceptions

NullPointerException:: if message is null

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides javax.print.attribute.TextSyntax.equals. Returns whether this printer message from operator 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 `PrinterMessageFromOperator`. This printer message from operator attribute's underlying string and `object`'s underlying string are equal. This printer message from operator attribute's locale and `object`'s locale are equal. Parameters object:Object `Object` to compare to Returns:boolean `true` if `object` is equivalent to this printer message from operator attribute, `false` otherwise

public boolean equals(Object object)

Overrides javax.print.attribute.TextSyntax.equals.

Returns whether this printer message from operator 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 PrinterMessageFromOperator.
This printer message from operator attribute's underlying string and object's underlying string are equal.
This printer message from operator attribute's locale and object's locale are equal.

Parameters

object:Object: Object to compare to

Returns:boolean

true if object is equivalent to this printer message from operator attribute, false otherwise

getCategory back to summary

getCategory	back to summary
public final Class<? extends Attribute> getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class `PrinterMessageFromOperator`, the category is class `PrinterMessageFromOperator` itself. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class`

public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class PrinterMessageFromOperator, the category is class PrinterMessageFromOperator itself.

Returns:Class<? extends Attribute>: printing attribute class (category), an instance of class java.lang.Class

getName back to summary

getName	back to summary
public final String getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance. For class `PrinterMessageFromOperator`, the category name is `"printer-message-from-operator"`. Returns:String attribute category name

public final String getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

For class PrinterMessageFromOperator, the category name is "printer-message-from-operator".

Returns:String: attribute category name

public final Class PrinterMessageFromOperator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail