< prev index next >
src/java.desktop/share/classes/javax/print/attribute/standard/PrinterMoreInfo.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+ * 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
@@ -20,103 +20,101 @@
*
* 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.net.URI;
import javax.print.attribute.Attribute;
-import javax.print.attribute.URISyntax;
import javax.print.attribute.PrintServiceAttribute;
+import javax.print.attribute.URISyntax;
/**
- * Class PrinterMoreInfo is a printing attribute class, a URI, that is used to
- * obtain more information about this specific printer. For example, this
- * could be an HTTP type URI referencing an HTML page accessible to a web
- * browser. The information obtained from this URI is intended for end user
- * consumption. Features outside the scope of the Print Service API can be
- * accessed from this URI.
- * The information is intended to be specific to this printer instance and
- * site specific services (e.g. job pricing, services offered, end user
- * assistance).
- * <P>
- * In contrast, the {@link PrinterMoreInfoManufacturer
- * PrinterMoreInfoManufacturer} attribute is used to find out more information
- * about this general kind of printer rather than this specific printer.
- * <P>
- * <B>IPP Compatibility:</B> The string form returned by
- * {@code toString()} gives the IPP uri value.
- * The category name returned by {@code getName()}
+ * Class {@code PrinterMoreInfo} is a printing attribute class, a {@code URI},
+ * that is used to obtain more information about this specific printer. For
+ * example, this could be an HTTP type {@code URI} referencing an HTML page
+ * accessible to a web browser. The information obtained from this {@code URI}
+ * is intended for end user consumption. Features outside the scope of the Print
+ * Service API can be accessed from this {@code URI}. The information is
+ * intended to be specific to this printer instance and site specific services
+ * (e.g. job pricing, services offered, end user assistance).
+ * <p>
+ * In contrast, the
+ * {@link PrinterMoreInfoManufacturer PrinterMoreInfoManufacturer} attribute is
+ * used to find out more information about this general kind of printer rather
+ * than this specific printer.
+ * <p>
+ * <b>IPP Compatibility:</b> The string form returned by {@code toString()}
+ * gives the IPP uri value. The category name returned by {@code getName()}
* gives the IPP attribute name.
*
* @author Alan Kaminsky
*/
public final class PrinterMoreInfo extends URISyntax
implements PrintServiceAttribute {
+ /**
+ * Use serialVersionUID from JDK 1.4 for interoperability.
+ */
private static final long serialVersionUID = 4555850007675338574L;
/**
- * Constructs a new printer more info attribute with the specified URI.
+ * Constructs a new printer more info attribute with the specified
+ * {@code URI}.
*
- * @param uri URI.
- *
- * @exception NullPointerException
- * (unchecked exception) Thrown if {@code uri} is null.
+ * @param uri {@code URI}
+ * @throws NullPointerException if {@code uri} is {@code null}
*/
public PrinterMoreInfo(URI uri) {
super (uri);
}
/**
* Returns whether this printer more info 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 null.
- * <LI>
- * {@code object} is an instance of class PrinterMoreInfo.
- * <LI>
- * This printer more info attribute's URI and {@code object}'s URI
- * are equal.
- * </OL>
- *
- * @param object Object to compare to.
- *
- * @return True if {@code object} is equivalent to this printer
- * more info attribute, false otherwise.
+ * 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 PrinterMoreInfo}.
+ * <li>This printer more info attribute's {@code URI} and {@code object}'s
+ * {@code URI} are equal.
+ * </ol>
+ *
+ * @param object {@code Object} to compare to
+ * @return {@code true} if {@code object} is equivalent to this printer more
+ * info attribute, {@code false} otherwise
*/
public boolean equals(Object object) {
return (super.equals(object) &&
object instanceof PrinterMoreInfo);
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
- * <P>
- * For class PrinterMoreInfo, the category is class PrinterMoreInfo itself.
+ * <p>
+ * For class {@code PrinterMoreInfo}, the category is class
+ * {@code PrinterMoreInfo} itself.
*
- * @return Printing attribute class (category), an instance of class
- * {@link java.lang.Class java.lang.Class}.
+ * @return printing attribute class (category), an instance of class
+ * {@link Class java.lang.Class}
*/
public final Class<? extends Attribute> getCategory() {
return PrinterMoreInfo.class;
}
/**
* Get the name of the category of which this attribute value is an
* instance.
- * <P>
- * For class PrinterMoreInfo, the
- * category name is {@code "printer-more-info"}.
+ * <p>
+ * For class {@code PrinterMoreInfo}, the category name is
+ * {@code "printer-more-info"}.
*
- * @return Attribute category name.
+ * @return attribute category name
*/
public final String getName() {
return "printer-more-info";
}
-
}
< prev index next >