PrintJobAttributeSet.java

/* PrintJobAttributeSet.java --
   Copyright (C) 2003, 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath 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 for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.print.attribute;

/**
 * <code>PrintJobAttributeSet</code> specifies an attribute set which only
 * allows printing attributes of type
 * {@link javax.print.attribute.PrintJobAttribute}.
 * <p>
 * The methods {@link #add(Attribute)} and {@link #addAll(AttributeSet)} are
 * respecified in this interface to indicate that only
 * <code>PrintJobAttribute</code> instances are allowed in this set.
 * </p>
 *
 * @author Michael Koch (konqueror@gmx.de)
 */
public interface PrintJobAttributeSet extends AttributeSet
{
  /**
   * Adds the specified attribute value to this attribute set
   * if it is not already present.
   *
   * This operation removes any existing attribute of the same category
   * before adding the given attribute.
   *
   * @param attribute the attribute to add.
   * @return <code>true</code> if the set is changed, false otherwise.
   * @throws ClassCastException if attribute is not of type
   * <code>PrintJobAttribute</code>.
   * @throws NullPointerException if the attribute is <code>null</code>.
   * @throws UnmodifiableSetException if the set does not support modification.
   */
  boolean add (Attribute attribute);

  /**
   * Adds all of the elements in the specified set to this attribute set.
   *
   * @param attributes the set of attributes to add.
   * @return <code>true</code> if the set is changed, false otherwise.
   * @throws ClassCastException if one of the attributes is not of type
   * <code>PrintJobAttribute</code>.
   * @throws UnmodifiableSetException if the set does not support modification.
   *
   * @see #add(Attribute)
   */
  boolean addAll (AttributeSet attributes);
}