javax.print.attribute.standard

Class JobMessageFromOperator

java.lang.Object

javax.print.attribute.TextSyntax

javax.print.attribute.standard.JobMessageFromOperator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.print.attribute.Attribute, javax.print.attribute.PrintJobAttribute

public final class JobMessageFromOperator
extends javax.print.attribute.TextSyntax
implements javax.print.attribute.PrintJobAttribute

The JobMessageFromOperator printing attribute provides a message from an operator or a system administrator related to the print job. This may include information why a certain action has been taken on the print job like a modification.

IPP Compatibility: JobMessageFromOperator is an IPP 1.1 attribute.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobMessageFromOperator(java.lang.String message, java.util.Locale locale) Creates a JobMessageFromOperator object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Tests if the given object is equal to this object.
java.lang.Class<? extends javax.print.attribute.Attribute>	getCategory() Returns category of this class.
java.lang.String	getName() Returns the name of this attribute.

Methods inherited from class javax.print.attribute.TextSyntax

getLocale, getValue, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JobMessageFromOperator

public JobMessageFromOperator(java.lang.String message,
                      java.util.Locale locale)

Creates a JobMessageFromOperator object.

Parameters:

message - the message

locale - the locale to use, if null the default locale is used.

Throws:

java.lang.NullPointerException - if message is null.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Tests if the given object is equal to this object.

Overrides:

equals in class javax.print.attribute.TextSyntax

Parameters:

obj - the object to test

Returns:

true if both objects are equal, false otherwise.

See Also:

Object.hashCode()

getCategory

public java.lang.Class<? extends javax.print.attribute.Attribute> getCategory()

Returns category of this class.

Specified by:

getCategory in interface javax.print.attribute.Attribute

Returns:

The class JobMessageFromOperator itself.

getName

public java.lang.String getName()

Returns the name of this attribute.

Specified by:

getName in interface javax.print.attribute.Attribute

Returns:

The name "job-message-from-operator".