Source for javax.swing.text.MutableAttributeSet

   1: /* MutableAttributeSet.java --
   2:    Copyright (C) 2002, 2004, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.swing.text;
  39: 
  40: import java.util.Enumeration;
  41: 
  42: /**
  43:  * An {@link AttributeSet} that supports modification of the stored 
  44:  * attributes.
  45:  * 
  46:  * @author    Andrew Selkirk
  47:  * @since 1.2
  48:  */
  49: public interface MutableAttributeSet extends AttributeSet
  50: {
  51:   /**
  52:    * Adds an attribute with the given <code>name</code> and <code>value</code>
  53:    * to the set.  If the set already contains an attribute with the given
  54:    * <code>name</code>, the attribute value is updated.
  55:    * 
  56:    * @param name  the attribute name (<code>null</code> not permitted).
  57:    * @param value  the value (<code>null</code> not permitted).
  58:    * 
  59:    * @throws NullPointerException if either argument is <code>null</code>.
  60:    */
  61:   void addAttribute(Object name, Object value);
  62: 
  63:   /**
  64:    * Adds all the attributes from <code>attributes</code> to this set.
  65:    * 
  66:    * @param attributes  the set of attributes to add (<code>null</code> not
  67:    *                    permitted).
  68:    *                    
  69:    * @throws NullPointerException if <code>attributes</code> is 
  70:    *         <code>null</code>.
  71:    */
  72:   void addAttributes(AttributeSet attributes);
  73: 
  74:   /**
  75:    * Removes the attribute with the specified <code>name</code>, if this 
  76:    * attribute is defined.  This method will only remove an attribute from
  77:    * this set, not from the resolving parent.
  78:    * 
  79:    * @param name  the attribute name (<code>null</code> not permitted).
  80:    * 
  81:    * @throws NullPointerException if <code>name</code> is <code>null</code>.
  82:    */
  83:   void removeAttribute(Object name);
  84: 
  85:   /**
  86:    * Removes the attributes listed in <code>names</code>.
  87:    * 
  88:    * @param names  the attribute names (<code>null</code> not permitted).
  89:    * 
  90:    * @throws NullPointerException if <code>names</code> is <code>null</code> 
  91:    *         or contains any <code>null</code> values.
  92:    */
  93:   void removeAttributes(Enumeration<?> names);
  94: 
  95:   /**
  96:    * Removes attributes from this set if they are found in the 
  97:    * given set.  Only attributes whose key AND value are removed.
  98:    * Removes attributes only from this set, not from the resolving parent.  
  99:    * Since the resolving parent is stored as an attribute, if 
 100:    * <code>attributes</code> has the same resolving parent as this set, the
 101:    * parent will be removed from this set.
 102:    * 
 103:    * @param attributes  the attributes (<code>null</code> not permitted).
 104:    */
 105:   void removeAttributes(AttributeSet attributes);
 106: 
 107:   /**
 108:    * Sets the reolving parent for this set.  When looking up an attribute, if
 109:    * it is not found in this set, then the resolving parent is also used for
 110:    * the lookup. 
 111:    * 
 112:    * @param parent  the parent attribute set (<code>null</code> not permitted).
 113:    * 
 114:    * @throws NullPointerException if <code>parent</code> is <code>null</code>.
 115:    */
 116:   void setResolveParent(AttributeSet parent);
 117: }