/* * Copyright (c) 2000, 2014, 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.Collection; import java.util.HashSet; import javax.print.attribute.Attribute; import javax.print.attribute.PrintJobAttribute; /** * Class JobStateReasons is a printing attribute class, a set of enumeration * values, that provides additional information about the job's current state, * i.e., information that augments the value of the job's {@link JobState * JobState} attribute. *
* Instances of {@link JobStateReason JobStateReason} do not appear in a Print * Job's attribute set directly. Rather, a JobStateReasons attribute appears in * the Print Job's attribute set. The JobStateReasons attribute contains zero, * one, or more than one {@link JobStateReason JobStateReason} objects which * pertain to the Print Job's status. The printer adds a {@link JobStateReason * JobStateReason} object to the Print Job's JobStateReasons attribute when the * corresponding condition becomes true of the Print Job, and the printer * removes the {@link JobStateReason JobStateReason} object again when the * corresponding condition becomes false, regardless of whether the Print Job's * overall {@link JobState JobState} also changed. *
* Class JobStateReasons inherits its implementation from class {@link * java.util.HashSet java.util.HashSet}. Unlike most printing attributes which * are immutable once constructed, class JobStateReasons is designed to be * mutable; you can add {@link JobStateReason JobStateReason} objects to an * existing JobStateReasons object and remove them again. However, like class * {@link java.util.HashSet java.util.HashSet}, class JobStateReasons is not * multiple thread safe. If a JobStateReasons object will be used by multiple * threads, be sure to synchronize its operations (e.g., using a synchronized * set view obtained from class {@link java.util.Collections * java.util.Collections}). *
* IPP Compatibility: The string value returned by each individual {@link
* JobStateReason JobStateReason} object's {@code toString()} method gives
* the IPP keyword value. The category name returned by {@code getName()}
* gives the IPP attribute name.
*
* @author Alan Kaminsky
*/
public final class JobStateReasons
extends HashSet
* For class JobStateReasons, the category is class JobStateReasons itself.
*
* @return Printing attribute class (category), an instance of class
* {@link java.lang.Class java.lang.Class}.
*/
public final Class extends Attribute> getCategory() {
return JobStateReasons.class;
}
/**
* Get the name of the category of which this attribute value is an
* instance.
*
* For class JobStateReasons, the category
* name is {@code "job-state-reasons"}.
*
* @return Attribute category name.
*/
public final String getName() {
return "job-state-reasons";
}
}