1/*
2 * Copyright (c) 1997, 2004, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package javax.swing.text;
26
27import java.util.Enumeration;
28
29/**
30 * A generic interface for a mutable collection of unique attributes.
31 *
32 * Implementations will probably want to provide a constructor of the
33 * form: <pre>{@code
34 * public XXXAttributeSet(ConstAttributeSet source);}</pre>
35 *
36 */
37public interface MutableAttributeSet extends AttributeSet {
38
39    /**
40     * Creates a new attribute set similar to this one except that it contains
41     * an attribute with the given name and value.  The object must be
42     * immutable, or not mutated by any client.
43     *
44     * @param name the name
45     * @param value the value
46     */
47    public void addAttribute(Object name, Object value);
48
49    /**
50     * Creates a new attribute set similar to this one except that it contains
51     * the given attributes and values.
52     *
53     * @param attributes the set of attributes
54     */
55    public void addAttributes(AttributeSet attributes);
56
57    /**
58     * Removes an attribute with the given {@code name}.
59     *
60     * @param name the attribute name
61     */
62    public void removeAttribute(Object name);
63
64    /**
65     * Removes an attribute set with the given {@code names}.
66     *
67     * @param names the set of names
68     */
69    public void removeAttributes(Enumeration<?> names);
70
71    /**
72     * Removes a set of attributes with the given {@code name}.
73     *
74     * @param attributes the set of attributes
75     */
76    public void removeAttributes(AttributeSet attributes);
77
78    /**
79     * Sets the resolving parent.  This is the set
80     * of attributes to resolve through if an attribute
81     * isn't defined locally.
82     *
83     * @param parent the parent
84     */
85    public void setResolveParent(AttributeSet parent);
86
87}
88