/*
 * Copyright (c) 2001, 2021, 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.io.Serial;
import java.net.URI;

import javax.print.attribute.Attribute;
import javax.print.attribute.PrintServiceAttribute;
import javax.print.attribute.URISyntax;

Class PrinterURI is a printing attribute class, a URI, that specifies the globally unique name of a printer. If it has such a name, an administrator determines a printer's URI and sets this attribute to that name.

IPP Compatibility: This implements the IPP printer-uri attribute. The string form returned by toString() gives the IPP printer-uri value. The category name returned by getName() gives the IPP attribute name.

Author:Robert Herriot
/** * Class {@code PrinterURI} is a printing attribute class, a {@code URI}, that * specifies the globally unique name of a printer. If it has such a name, an * administrator determines a printer's {@code URI} and sets this attribute to * that name. * <p> * <b>IPP Compatibility:</b> This implements the IPP printer-uri attribute. The * string form returned by {@code toString()} gives the IPP printer-uri value. * The category name returned by {@code getName()} gives the IPP attribute name. * * @author Robert Herriot */
public final class PrinterURI extends URISyntax implements PrintServiceAttribute {
Use serialVersionUID from JDK 1.4 for interoperability.
/** * Use serialVersionUID from JDK 1.4 for interoperability. */
@Serial private static final long serialVersionUID = 7923912792485606497L;
Constructs a new PrinterURI attribute with the specified URI.
Params:
  • uri – URI of the printer
Throws:
/** * Constructs a new {@code PrinterURI} attribute with the specified * {@code URI}. * * @param uri {@code URI} of the printer * @throws NullPointerException if {@code uri} is {@code null} */
public PrinterURI(URI uri) { super (uri); }
Returns whether this printer name 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 PrinterURI.
  3. This PrinterURI attribute's underlying URI and object's underlying URI are equal.
Params:
  • object – Object to compare to
Returns:true if object is equivalent to this PrinterURI attribute, false otherwise
/** * Returns whether this printer name 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 PrinterURI}. * <li>This {@code PrinterURI} attribute's underlying {@code URI} and * {@code object}'s underlying {@code URI} are equal. * </ol> * * @param object {@code Object} to compare to * @return {@code true} if {@code object} is equivalent to this * {@code PrinterURI} attribute, {@code false} otherwise */
public boolean equals(Object object) { return (super.equals(object) && object instanceof PrinterURI); }
Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class PrinterURI and any vendor-defined subclasses, the category is class PrinterURI itself.

Returns:printing attribute class (category), an instance of class java.lang.Class
/** * Get the printing attribute class which is to be used as the "category" * for this printing attribute value. * <p> * For class {@code PrinterURI} and any vendor-defined subclasses, the * category is class {@code PrinterURI} itself. * * @return printing attribute class (category), an instance of class * {@link Class java.lang.Class} */
public final Class<? extends Attribute> getCategory() { return PrinterURI.class; }
Get the name of the category of which this attribute value is an instance.

For class PrinterURI and any vendor-defined subclasses, the category name is "printer-uri".

Returns:attribute category name
/** * Get the name of the category of which this attribute value is an * instance. * <p> * For class {@code PrinterURI} and any vendor-defined subclasses, the * category name is {@code "printer-uri"}. * * @return attribute category name */
public final String getName() { return "printer-uri"; } }