001/* MutableAttributeSet.java --
002   Copyright (C) 2002, 2004, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.swing.text;
039
040import java.util.Enumeration;
041
042/**
043 * An {@link AttributeSet} that supports modification of the stored
044 * attributes.
045 *
046 * @author      Andrew Selkirk
047 * @since 1.2
048 */
049public interface MutableAttributeSet extends AttributeSet
050{
051  /**
052   * Adds an attribute with the given <code>name</code> and <code>value</code>
053   * to the set.  If the set already contains an attribute with the given
054   * <code>name</code>, the attribute value is updated.
055   *
056   * @param name  the attribute name (<code>null</code> not permitted).
057   * @param value  the value (<code>null</code> not permitted).
058   *
059   * @throws NullPointerException if either argument is <code>null</code>.
060   */
061  void addAttribute(Object name, Object value);
062
063  /**
064   * Adds all the attributes from <code>attributes</code> to this set.
065   *
066   * @param attributes  the set of attributes to add (<code>null</code> not
067   *                    permitted).
068   *
069   * @throws NullPointerException if <code>attributes</code> is
070   *         <code>null</code>.
071   */
072  void addAttributes(AttributeSet attributes);
073
074  /**
075   * Removes the attribute with the specified <code>name</code>, if this
076   * attribute is defined.  This method will only remove an attribute from
077   * this set, not from the resolving parent.
078   *
079   * @param name  the attribute name (<code>null</code> not permitted).
080   *
081   * @throws NullPointerException if <code>name</code> is <code>null</code>.
082   */
083  void removeAttribute(Object name);
084
085  /**
086   * Removes the attributes listed in <code>names</code>.
087   *
088   * @param names  the attribute names (<code>null</code> not permitted).
089   *
090   * @throws NullPointerException if <code>names</code> is <code>null</code>
091   *         or contains any <code>null</code> values.
092   */
093  void removeAttributes(Enumeration<?> names);
094
095  /**
096   * Removes attributes from this set if they are found in the
097   * given set.  Only attributes whose key AND value are removed.
098   * Removes attributes only from this set, not from the resolving parent.
099   * 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}