src/share/classes/javax/print/attribute/PrintServiceAttributeSet.java

Print this page


   1 /*
   2  * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  25 
  26 
  27 package javax.print.attribute;
  28 
  29 /**
  30  * Interface PrintServiceAttributeSet specifies the interface for a set of
  31  * print job attributes, i.e. printing attributes that implement interface
  32  * {@link
  33  * PrintServiceAttribute PrintServiceAttribute}. In the Print Service API,
  34  * the Print Service instance uses a PrintServiceAttributeSet to report the
  35  * status of the print service.
  36  * <P>
  37  * A PrintServiceAttributeSet is just an {@link AttributeSet AttributeSet}
  38  * whose constructors and mutating operations guarantee an additional
  39  * invariant,
  40  * namely that all attribute values in the PrintServiceAttributeSet must be
  41  * instances of interface {@link PrintServiceAttribute PrintServiceAttribute}.
  42  * The {@link #add(Attribute) add(Attribute)}, and
  43  * {@link #addAll(AttributeSet) addAll(AttributeSet)} operations
  44  * are respecified below to guarantee this additional invariant.
  45  * <P>
  46  *
  47  * @author  Alan Kaminsky
  48  */
  49 public interface PrintServiceAttributeSet extends AttributeSet {
  50 
  51 
  52 
  53     /**
  54      * Adds the specified attribute value to this attribute set if it is not
  55      * already present, first removing any existing value in the same
  56      * attribute category as the specified attribute value (optional
  57      * operation).
  58      *
  59      * @param  attribute  Attribute value to be added to this attribute set.
  60      *
  61      * @return  <tt>true</tt> if this attribute set changed as a result of
  62      *          the call, i.e., the given attribute value was not already a
  63      *          member of this attribute set.
  64      *
  65      * @throws  UnmodifiableSetException


   1 /*
   2  * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  25 
  26 
  27 package javax.print.attribute;
  28 
  29 /**
  30  * Interface PrintServiceAttributeSet specifies the interface for a set of
  31  * print job attributes, i.e. printing attributes that implement interface
  32  * {@link
  33  * PrintServiceAttribute PrintServiceAttribute}. In the Print Service API,
  34  * the Print Service instance uses a PrintServiceAttributeSet to report the
  35  * status of the print service.
  36  * <P>
  37  * A PrintServiceAttributeSet is just an {@link AttributeSet AttributeSet}
  38  * whose constructors and mutating operations guarantee an additional
  39  * invariant,
  40  * namely that all attribute values in the PrintServiceAttributeSet must be
  41  * instances of interface {@link PrintServiceAttribute PrintServiceAttribute}.
  42  * The {@link #add(Attribute) add(Attribute)}, and
  43  * {@link #addAll(AttributeSet) addAll(AttributeSet)} operations
  44  * are respecified below to guarantee this additional invariant.

  45  *
  46  * @author  Alan Kaminsky
  47  */
  48 public interface PrintServiceAttributeSet extends AttributeSet {
  49 
  50 
  51 
  52     /**
  53      * Adds the specified attribute value to this attribute set if it is not
  54      * already present, first removing any existing value in the same
  55      * attribute category as the specified attribute value (optional
  56      * operation).
  57      *
  58      * @param  attribute  Attribute value to be added to this attribute set.
  59      *
  60      * @return  <tt>true</tt> if this attribute set changed as a result of
  61      *          the call, i.e., the given attribute value was not already a
  62      *          member of this attribute set.
  63      *
  64      * @throws  UnmodifiableSetException