Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.print.attribute.standard
Class PrinterMessageFromOperator

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.attribute.TextSyntax sample code for javax.print.attribute.TextSyntax definition code for javax.print.attribute.TextSyntax 
      extended by javax.print.attribute.standard.PrinterMessageFromOperator
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute , PrintServiceAttribute sample code for javax.print.attribute.PrintServiceAttribute definition code for javax.print.attribute.PrintServiceAttribute 
public final class PrinterMessageFromOperator
extends TextSyntax sample code for javax.print.attribute.TextSyntax definition code for javax.print.attribute.TextSyntax 
implements PrintServiceAttribute sample code for javax.print.attribute.PrintServiceAttribute definition code for javax.print.attribute.PrintServiceAttribute

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.

See Also:
Serialized Form

Constructor Summary
PrinterMessageFromOperator sample code for javax.print.attribute.standard.PrinterMessageFromOperator.PrinterMessageFromOperator(java.lang.String, java.util.Locale) definition code for javax.print.attribute.standard.PrinterMessageFromOperator.PrinterMessageFromOperator(java.lang.String, java.util.Locale) (String sample code for java.lang.String definition code for java.lang.String  message, Locale sample code for java.util.Locale definition code for java.util.Locale  locale)
          Constructs a new printer message from operator attribute with the given message and locale.
 
Method Summary
 boolean equals sample code for javax.print.attribute.standard.PrinterMessageFromOperator.equals(java.lang.Object) definition code for javax.print.attribute.standard.PrinterMessageFromOperator.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  object)
          Returns whether this printer message from operator attribute is equivalent to the passed in object.
 Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute > getCategory sample code for javax.print.attribute.standard.PrinterMessageFromOperator.getCategory() definition code for javax.print.attribute.standard.PrinterMessageFromOperator.getCategory() ()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.print.attribute.standard.PrinterMessageFromOperator.getName() definition code for javax.print.attribute.standard.PrinterMessageFromOperator.getName() ()
          Get the name of the category of which this attribute value is an instance.
 
Methods inherited from class javax.print.attribute.TextSyntax sample code for javax.print.attribute.TextSyntax definition code for javax.print.attribute.TextSyntax
getLocale sample code for javax.print.attribute.TextSyntax.getLocale() definition code for javax.print.attribute.TextSyntax.getLocale() , getValue sample code for javax.print.attribute.TextSyntax.getValue() definition code for javax.print.attribute.TextSyntax.getValue() , hashCode sample code for javax.print.attribute.TextSyntax.hashCode() definition code for javax.print.attribute.TextSyntax.hashCode() , toString sample code for javax.print.attribute.TextSyntax.toString() definition code for javax.print.attribute.TextSyntax.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

PrinterMessageFromOperator sample code for javax.print.attribute.standard.PrinterMessageFromOperator(java.lang.String, java.util.Locale) definition code for javax.print.attribute.standard.PrinterMessageFromOperator(java.lang.String, java.util.Locale) 

public PrinterMessageFromOperator(String sample code for java.lang.String definition code for java.lang.String  message,
                                  Locale sample code for java.util.Locale definition code for java.util.Locale  locale)
Constructs a new printer message from operator attribute with the given message and locale.

Parameters:
message - Message.
locale - Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - (unchecked exception) Thrown if message is null.
Method Detail

equals sample code for javax.print.attribute.standard.PrinterMessageFromOperator.equals(java.lang.Object) definition code for javax.print.attribute.standard.PrinterMessageFromOperator.equals(java.lang.Object) 

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  object)
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:
  1. object is not null.
  2. object is an instance of class PrinterMessageFromOperator.
  3. This printer message from operator attribute's underlying string and object's underlying string are equal.
  4. This printer message from operator attribute's locale and object's locale are equal.

Overrides:
equals sample code for javax.print.attribute.TextSyntax.equals(java.lang.Object) definition code for javax.print.attribute.TextSyntax.equals(java.lang.Object) in class TextSyntax sample code for javax.print.attribute.TextSyntax definition code for javax.print.attribute.TextSyntax
Parameters:
object - Object to compare to.
Returns:
True if object is equivalent to this printer message from operator attribute, false otherwise.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

getCategory sample code for javax.print.attribute.standard.PrinterMessageFromOperator.getCategory() definition code for javax.print.attribute.standard.PrinterMessageFromOperator.getCategory() 

public final Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for 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.

Specified by:
getCategory sample code for javax.print.attribute.Attribute.getCategory() definition code for javax.print.attribute.Attribute.getCategory() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class sample code for java.lang.Class definition code for java.lang.Class .

getName sample code for javax.print.attribute.standard.PrinterMessageFromOperator.getName() definition code for javax.print.attribute.standard.PrinterMessageFromOperator.getName() 

public final String sample code for java.lang.String definition code for java.lang.String  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".

Specified by:
getName sample code for javax.print.attribute.Attribute.getName() definition code for javax.print.attribute.Attribute.getName() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Attribute category name.
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD