001    /* PrintJobAttributeSet.java --
002       Copyright (C) 2003, 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    package javax.print.attribute;
039    
040    /**
041     * <code>PrintJobAttributeSet</code> specifies an attribute set which only
042     * allows printing attributes of type
043     * {@link javax.print.attribute.PrintJobAttribute}.
044     * <p>
045     * The methods {@link #add(Attribute)} and {@link #addAll(AttributeSet)} are
046     * respecified in this interface to indicate that only
047     * <code>PrintJobAttribute</code> instances are allowed in this set.
048     * </p>
049     *
050     * @author Michael Koch (konqueror@gmx.de)
051     */
052    public interface PrintJobAttributeSet extends AttributeSet
053    {
054      /**
055       * Adds the specified attribute value to this attribute set
056       * if it is not already present.
057       *
058       * This operation removes any existing attribute of the same category
059       * before adding the given attribute.
060       *
061       * @param attribute the attribute to add.
062       * @return <code>true</code> if the set is changed, false otherwise.
063       * @throws ClassCastException if attribute is not of type
064       * <code>PrintJobAttribute</code>.
065       * @throws NullPointerException if the attribute is <code>null</code>.
066       * @throws UnmodifiableSetException if the set does not support modification.
067       */
068      boolean add (Attribute attribute);
069    
070      /**
071       * Adds all of the elements in the specified set to this attribute set.
072       *
073       * @param attributes the set of attributes to add.
074       * @return <code>true</code> if the set is changed, false otherwise.
075       * @throws ClassCastException if one of the attributes is not of type
076       * <code>PrintJobAttribute</code>.
077       * @throws UnmodifiableSetException if the set does not support modification.
078       *
079       * @see #add(Attribute)
080       */
081      boolean addAll (AttributeSet attributes);
082    }