| /* |
| * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package javax.print.attribute.standard; |
| |
| import java.util.Locale; |
| |
| import javax.print.attribute.Attribute; |
| import javax.print.attribute.PrintServiceAttribute; |
| import javax.print.attribute.TextSyntax; |
| |
| /** |
| * Class {@code PrinterLocation} is a printing attribute class, a text |
| * attribute, that identifies the location of the device. This could include |
| * things like: {@code "in Room 123A, second floor of building XYZ"}. |
| * <p> |
| * <b>IPP Compatibility:</b> The string value gives the IPP name value. The |
| * locale gives the IPP natural language. The category name returned by |
| * {@code getName()} gives the IPP attribute name. |
| * |
| * @author Alan Kaminsky |
| */ |
| public final class PrinterLocation extends TextSyntax |
| implements PrintServiceAttribute { |
| |
| /** |
| * Use serialVersionUID from JDK 1.4 for interoperability. |
| */ |
| private static final long serialVersionUID = -1598610039865566337L; |
| |
| /** |
| * Constructs a new printer location attribute with the given location and |
| * locale. |
| * |
| * @param location printer location |
| * @param locale natural language of the text string. {@code null} is |
| * interpreted to mean the default locale as returned by |
| * {@code Locale.getDefault()} |
| * @throws NullPointerException if {@code location} is {@code null} |
| */ |
| public PrinterLocation(String location, Locale locale) { |
| super (location, locale); |
| } |
| |
| /** |
| * Returns whether this printer location attribute is equivalent to the |
| * passed in object. To be equivalent, all of the following conditions must |
| * be true: |
| * <ol type=1> |
| * <li>{@code object} is not {@code null}. |
| * <li>{@code object} is an instance of class {@code PrinterLocation}. |
| * <li>This printer location attribute's underlying string and |
| * {@code object}'s underlying string are equal. |
| * <li>This printer location attribute's locale and {@code object}'s |
| * locale are equal. |
| * </ol> |
| * |
| * @param object {@code Object} to compare to |
| * @return {@code true} if {@code object} is equivalent to this printer |
| * location attribute, {@code false} otherwise |
| */ |
| public boolean equals(Object object) { |
| return (super.equals(object) && object instanceof PrinterLocation); |
| } |
| |
| /** |
| * Get the printing attribute class which is to be used as the "category" |
| * for this printing attribute value. |
| * <p> |
| * For class {@code PrinterLocation}, the category is class |
| * {@code PrinterLocation} itself. |
| * |
| * @return printing attribute class (category), an instance of class |
| * {@link Class java.lang.Class} |
| */ |
| public final Class<? extends Attribute> getCategory() { |
| return PrinterLocation.class; |
| } |
| |
| /** |
| * Get the name of the category of which this attribute value is an |
| * instance. |
| * <p> |
| * For class {@code PrinterLocation}, the category name is |
| * {@code "printer-location"}. |
| * |
| * @return attribute category name |
| */ |
| public final String getName() { |
| return "printer-location"; |
| } |
| } |