src/share/classes/javax/print/attribute/standard/JobName.java

Print this page




  31 import javax.print.attribute.PrintRequestAttribute;
  32 import javax.print.attribute.PrintJobAttribute;
  33 
  34 /**
  35  * Class JobName is a printing attribute class, a text attribute, that specifies
  36  * the name of a print job. A job's name is an arbitrary string defined by the
  37  * client. It does not need to be unique between different jobs. A Print Job's
  38  * JobName attribute is set to the value supplied by the client in the Print
  39  * Request's attribute set. If, however, the client does not supply a JobName
  40  * attribute in the Print Request, the printer, when it creates the Print Job,
  41  * must generate a JobName. The printer should generate the value of the Print
  42  * Job's JobName attribute from the first of the following sources that produces
  43  * a value: (1) the {@link DocumentName DocumentName} attribute of the first (or
  44  * only) doc in the job, (2) the URL of the first (or only) doc in the job, if
  45  * the doc's print data representation object is a URL, or (3) any other piece
  46  * of Print Job specific and/or document content information.
  47  * <P>
  48  * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
  49  * locale gives the IPP natural language. The category name returned by
  50  * <CODE>getName()</CODE> gives the IPP attribute name.
  51  * <P>
  52  *
  53  * @author  Alan Kaminsky
  54  */
  55 public final class JobName extends TextSyntax
  56         implements PrintRequestAttribute, PrintJobAttribute {
  57 
  58     private static final long serialVersionUID = 4660359192078689545L;
  59 
  60     /**
  61      * Constructs a new job name attribute with the given job name and locale.
  62      *
  63      * @param  jobName  Job name.
  64      * @param  locale   Natural language of the text string. null
  65      * is interpreted to mean the default locale as returned
  66      * by <code>Locale.getDefault()</code>
  67      *
  68      * @exception  NullPointerException
  69      *     (unchecked exception) Thrown if <CODE>jobName</CODE> is null.
  70      */
  71     public JobName(String jobName, Locale locale) {




  31 import javax.print.attribute.PrintRequestAttribute;
  32 import javax.print.attribute.PrintJobAttribute;
  33 
  34 /**
  35  * Class JobName is a printing attribute class, a text attribute, that specifies
  36  * the name of a print job. A job's name is an arbitrary string defined by the
  37  * client. It does not need to be unique between different jobs. A Print Job's
  38  * JobName attribute is set to the value supplied by the client in the Print
  39  * Request's attribute set. If, however, the client does not supply a JobName
  40  * attribute in the Print Request, the printer, when it creates the Print Job,
  41  * must generate a JobName. The printer should generate the value of the Print
  42  * Job's JobName attribute from the first of the following sources that produces
  43  * a value: (1) the {@link DocumentName DocumentName} attribute of the first (or
  44  * only) doc in the job, (2) the URL of the first (or only) doc in the job, if
  45  * the doc's print data representation object is a URL, or (3) any other piece
  46  * of Print Job specific and/or document content information.
  47  * <P>
  48  * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
  49  * locale gives the IPP natural language. The category name returned by
  50  * <CODE>getName()</CODE> gives the IPP attribute name.

  51  *
  52  * @author  Alan Kaminsky
  53  */
  54 public final class JobName extends TextSyntax
  55         implements PrintRequestAttribute, PrintJobAttribute {
  56 
  57     private static final long serialVersionUID = 4660359192078689545L;
  58 
  59     /**
  60      * Constructs a new job name attribute with the given job name and locale.
  61      *
  62      * @param  jobName  Job name.
  63      * @param  locale   Natural language of the text string. null
  64      * is interpreted to mean the default locale as returned
  65      * by <code>Locale.getDefault()</code>
  66      *
  67      * @exception  NullPointerException
  68      *     (unchecked exception) Thrown if <CODE>jobName</CODE> is null.
  69      */
  70     public JobName(String jobName, Locale locale) {