AttributeSet.java 7.1 KB
Newer Older
Tom Tromey committed
1
/* AttributeSet.java -- 
2
   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
Tom Tromey committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

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;

/**
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
 * <code>AttributeSet</code> is the top-level interface for sets of printing
 * attributes in the Java Print Service API.
 * <p>
 * There are no duplicate values allowed in an attribute set and there is
 * at most one attribute object contained per category type. Based on the
 * {@link java.util.Map} interface the values of attribute sets are objects
 * of type {@link javax.print.attribute.Attribute} and the entries are the
 * categories as {@link java.lang.Class} instances.
 * </p>
 * <p>
 * The following specialized types of <code>AttributeSet</code> are available:
 * <ul>
 *  <li>{@link javax.print.attribute.DocAttributeSet}</li>
 *  <li>{@link javax.print.attribute.PrintRequestAttributeSet}</li>
 *  <li>{@link javax.print.attribute.PrintJobAttributeSet}</li>
 *  <li>{@link javax.print.attribute.PrintServiceAttributeSet}</li>
 * </ul>
 * </p>
 * <p>
 * Attribute sets may be unmodifiable depending on the context of usage. If 
 * used as read-only attribute set modifying operations throw an 
 * {@link javax.print.attribute.UnmodifiableSetException}.
 * </p>
 * <p>
 * The Java Print Service API provides implementation classes for the existing
 * attribute set interfaces but applications may use their own implementations.
 * </p>
 * 
 * @author Michael Koch (konqueror@gmx.de)
Tom Tromey committed
70 71 72 73
 */
public interface AttributeSet
{
  /**
74
   * Adds the specified attribute value to this attribute set 
Tom Tromey committed
75
   * if it is not already present.
76 77 78 79 80 81 82 83
   * 
   * This operation removes any existing attribute of the same category 
   * before adding the given attribute to the set. 
   * 
   * @param attribute the attribute to add.
   * @return <code>true</code> if the set is changed, false otherwise.
   * @throws NullPointerException if the attribute is <code>null</code>.
   * @throws UnmodifiableSetException if the set does not support modification.
Tom Tromey committed
84 85 86 87
   */
  boolean add (Attribute attribute);

  /**
88 89 90 91 92 93 94
   * 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 UnmodifiableSetException if the set does not support modification.
   * 
   * @see #add(Attribute)
Tom Tromey committed
95 96
   */
  boolean addAll (AttributeSet attributes);
97 98 99 100 101 102
  
  /**
   * Removes all attributes from this attribute set.
   * 
   * @throws UnmodifiableSetException if the set does not support modification.
   */
Tom Tromey committed
103
  void clear ();
104 105 106 107 108 109 110 111 112
  
  /**
   * Checks if this attributes set contains an attribute with the given 
   * category.
   * 
   * @param category the category to test for.
   * @return <code>true</code> if an attribute of the category is contained
   * in the set, <code>false</code> otherwise.
   */
113
  boolean containsKey (Class<?> category);
114 115 116 117 118 119 120 121
  
  /**
   * Checks if this attribute set contains the given attribute.
   * 
   * @param attribute the attribute to test for.
   * @return <code>true</code> if the attribute is contained in the set,
   * <code>false</code> otherwise.
   */
Tom Tromey committed
122 123
  boolean containsValue (Attribute attribute);
  
124 125 126 127 128 129 130 131
  /**
   * Tests this set for equality with the given object. <code>true</code> is
   * returned, if the given object is also of type <code>AttributeSet</code>
   * and the contained attributes are the same as in this set.
   * 
   * @param obj the Object to test.
   * @return <code>true</code> if equal, false otherwise.
   */
Tom Tromey committed
132
  boolean equals (Object obj);
133 134 135 136 137 138 139 140 141 142 143 144 145
  
  /**
   * Returns the attribute object contained in this set for the given attribute
   * category. 
   * 
   * @param category the category of the attribute. A <code>Class</code> 
   * instance of a class implementing the <code>Attribute</code> interface. 
   * @return The attribute for this category or <code>null</code> if no 
   * attribute is contained for the given category. 
   * @throws NullPointerException if category is null.
   * @throws ClassCastException if category is not implementing 
   * <code>Attribute</code>.
   */
146
  Attribute get (Class<?> category);
147 148 149 150 151 152 153
  
  /**
   * Returns the hashcode value. The hashcode value is the sum of all hashcodes
   * of the attributes contained in this set.
   * 
   * @return The hashcode for this attribute set.
   */
Tom Tromey committed
154
  int hashCode ();
155 156 157 158 159 160
  
  /**
   * Checks if the attribute set is empty.
   *
   * @return <code>true</code> if the attribute set is empty, false otherwise.
   */
Tom Tromey committed
161 162
  boolean isEmpty ();

163 164 165 166 167 168 169 170
  /**
   * Removes the given attribute from the set. If the given attribute is <code>null</code>
   * nothing is done and <code>false</code> is returned.
   * 
   * @param attribute the attribute to remove.  
   * @return <code>true</code> if removed, false in all other cases. 
   * @throws UnmodifiableSetException if the set does not support modification.
   */
Tom Tromey committed
171
  boolean remove (Attribute attribute);
172 173 174 175 176 177 178 179 180
  
  /**
   * Removes the attribute entry of the given category from the set. If the given
   * category is <code>null</code> nothing is done and <code>false</code> is returned.
   * 
   * @param category the category of the entry to be removed.
   * @return <code>true</code> if an attribute is removed, false in all other cases. 
   * @throws UnmodifiableSetException if the set does not support modification.
   */
181
  boolean remove (Class<?> category);
182 183 184 185 186 187
  
  /**
   * Returns the number of elements in this attribute set.
   *
   * @return The number of elements.
   */
Tom Tromey committed
188
  int size ();
189 190 191 192 193 194
  
  /**
   * Returns the content of the attribute set as an array
   *
   * @return An array of attributes.
   */
Tom Tromey committed
195 196
  Attribute[] toArray ();
}