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

Print this page


   1 /*
   2  * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.print.attribute.standard;
  26 
  27 import java.util.Locale;
  28 
  29 import javax.print.attribute.Attribute;
  30 import javax.print.attribute.TextSyntax;
  31 import javax.print.attribute.PrintServiceAttribute;
  32 
  33 /**
  34  * Class PrinterLocation is a printing attribute class, a text attribute, that
  35  * identifies the location of the device. This could include things like:
  36  * <CODE>"in Room 123A, second floor of building XYZ"</CODE>.
  37  * <P>
  38  * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
  39  * locale gives the IPP natural language. The category name returned by
  40  * <CODE>getName()</CODE> gives the IPP attribute name.
  41  * <P>
  42  *
  43  * @author  Alan Kaminsky
  44  */
  45 public final class PrinterLocation extends TextSyntax
  46     implements PrintServiceAttribute {
  47 
  48     private static final long serialVersionUID = -1598610039865566337L;
  49 
  50     /**
  51      * Constructs a new printer location attribute with the given location and
  52      * locale.
  53      *
  54      * @param  location  Printer location.
  55      * @param  locale    Natural language of the text string. null
  56      * is interpreted to mean the default locale as returned
  57      * by <code>Locale.getDefault()</code>
  58      *
  59      * @exception  NullPointerException
  60      *     (unchecked exception) Thrown if <CODE>location</CODE> is null.
  61      */


   1 /*
   2  * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.print.attribute.standard;
  26 
  27 import java.util.Locale;
  28 
  29 import javax.print.attribute.Attribute;
  30 import javax.print.attribute.TextSyntax;
  31 import javax.print.attribute.PrintServiceAttribute;
  32 
  33 /**
  34  * Class PrinterLocation is a printing attribute class, a text attribute, that
  35  * identifies the location of the device. This could include things like:
  36  * <CODE>"in Room 123A, second floor of building XYZ"</CODE>.
  37  * <P>
  38  * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
  39  * locale gives the IPP natural language. The category name returned by
  40  * <CODE>getName()</CODE> gives the IPP attribute name.

  41  *
  42  * @author  Alan Kaminsky
  43  */
  44 public final class PrinterLocation extends TextSyntax
  45     implements PrintServiceAttribute {
  46 
  47     private static final long serialVersionUID = -1598610039865566337L;
  48 
  49     /**
  50      * Constructs a new printer location attribute with the given location and
  51      * locale.
  52      *
  53      * @param  location  Printer location.
  54      * @param  locale    Natural language of the text string. null
  55      * is interpreted to mean the default locale as returned
  56      * by <code>Locale.getDefault()</code>
  57      *
  58      * @exception  NullPointerException
  59      *     (unchecked exception) Thrown if <CODE>location</CODE> is null.
  60      */