01: /*
02: * Copyright (c) 2007, intarsys consulting GmbH
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * - Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * - Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * - Neither the name of intarsys nor the names of its contributors may be used
15: * to endorse or promote products derived from this software without specific
16: * prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28: * POSSIBILITY OF SUCH DAMAGE.
29: */
30: package de.intarsys.tools.attribute;
31:
32: /**
33: * This interface declares support for "generic attributes".
34: *
35: * <p>
36: * This means the object implementing this interface may be extended
37: * transparently by its clients with name/value pairs. These attributes and
38: * their values are stored but not interpreted by the object that implements
39: * this interface.
40: * </p>
41: */
42: public interface IAttributeSupport {
43: /**
44: * set the value of an attribute in the context
45: *
46: * @param key
47: * the name of the attribute to set
48: * @param o
49: * the new value the attribute
50: *
51: * @return The previously associated object for <code>key</code>
52: */
53: public Object setAttribute(Object key, Object o);
54:
55: /**
56: * get an attribute from the context
57: *
58: * @param key
59: * the name of the attribute to get
60: *
61: * @return The value of the attribute to get
62: */
63: public Object getAttribute(Object key);
64:
65: /**
66: * remove an attribute in the context
67: *
68: * @param key
69: * the name of the attribute to remove
70: *
71: * @return The previously associated object for <code>key</code>
72: */
73: public Object removeAttribute(Object key);
74: }
|