/* * Copyright (c) 2000, 2004, 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.TextSyntax; import javax.print.attribute.PrintJobAttribute; /** * Class OutputDeviceAssigned is a printing attribute class, a text attribute, * that identifies the output device to which the service has assigned this * job. If an output device implements an embedded Print Service instance, the * printer need not set this attribute. If a print server implements a * Print Service instance, the value may be empty (zero- length string) or not * returned until the service assigns an output device to the job. This * attribute is particularly useful when a single service supports multiple * devices (so called "fan-out"). *
* IPP Compatibility: The string value gives the IPP name value. The
* locale gives the IPP natural language. The category name returned by
* getName()
gives the IPP attribute name.
*
*
* @author Alan Kaminsky
*/
public final class OutputDeviceAssigned extends TextSyntax
implements PrintJobAttribute {
private static final long serialVersionUID = 5486733778854271081L;
/**
* Constructs a new output device assigned attribute with the given device
* name and locale.
*
* @param deviceName Device name.
* @param locale Natural language of the text string. null
* is interpreted to mean the default locale as returned
* by Locale.getDefault()
*
* @exception NullPointerException
* (unchecked exception) Thrown if deviceName
is null.
*/
public OutputDeviceAssigned(String deviceName, Locale locale) {
super (deviceName, locale);
}
// Exported operations inherited and overridden from class Object.
/**
* Returns whether this output device assigned attribute is equivalent to
* the passed in object. To be equivalent, all of the following conditions
* must be true:
*
object
is not null.
* object
is an instance of class OutputDeviceAssigned.
* object
's underlying string are equal.
* object
's locale are equal.
* object
is equivalent to this output
* device assigned attribute, false otherwise.
*/
public boolean equals(Object object) {
return (super.equals (object) &&
object instanceof OutputDeviceAssigned);
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
* * For class OutputDeviceAssigned, the * category is class OutputDeviceAssigned itself. * * @return Printing attribute class (category), an instance of class * {@link java.lang.Class java.lang.Class}. */ public final Class extends Attribute> getCategory() { return OutputDeviceAssigned.class; } /** * Get the name of the category of which this attribute value is an * instance. *
* For class OutputDeviceAssigned, the
* category name is "output-device-assigned"
.
*
* @return Attribute category name.
*/
public final String getName() {
return "output-device-assigned";
}
}