001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017:
018: package org.apache.commons.beanutils;
019:
020: /**
021: * <p>A <strong>DynaBean</strong> is a Java object that supports properties
022: * whose names and data types, as well as values, may be dynamically modified.
023: * To the maximum degree feasible, other components of the BeanUtils package
024: * will recognize such beans and treat them as standard JavaBeans for the
025: * purpose of retrieving and setting property values.</p>
026: *
027: * @author Craig McClanahan
028: * @author Paulo Gaspar
029: * @version $Revision: 555824 $ $Date: 2007-07-13 01:27:15 +0100 (Fri, 13 Jul 2007) $
030: */
031:
032: public interface DynaBean {
033:
034: /**
035: * Does the specified mapped property contain a value for the specified
036: * key value?
037: *
038: * @param name Name of the property to check
039: * @param key Name of the key to check
040: * @return <code>true<code> if the mapped property contains a value for
041: * the specified key, otherwise <code>false</code>
042: *
043: * @exception IllegalArgumentException if there is no property
044: * of the specified name
045: */
046: public boolean contains(String name, String key);
047:
048: /**
049: * Return the value of a simple property with the specified name.
050: *
051: * @param name Name of the property whose value is to be retrieved
052: * @return The property's value
053: *
054: * @exception IllegalArgumentException if there is no property
055: * of the specified name
056: */
057: public Object get(String name);
058:
059: /**
060: * Return the value of an indexed property with the specified name.
061: *
062: * @param name Name of the property whose value is to be retrieved
063: * @param index Index of the value to be retrieved
064: * @return The indexed property's value
065: *
066: * @exception IllegalArgumentException if there is no property
067: * of the specified name
068: * @exception IllegalArgumentException if the specified property
069: * exists, but is not indexed
070: * @exception IndexOutOfBoundsException if the specified index
071: * is outside the range of the underlying property
072: * @exception NullPointerException if no array or List has been
073: * initialized for this property
074: */
075: public Object get(String name, int index);
076:
077: /**
078: * Return the value of a mapped property with the specified name,
079: * or <code>null</code> if there is no value for the specified key.
080: *
081: * @param name Name of the property whose value is to be retrieved
082: * @param key Key of the value to be retrieved
083: * @return The mapped property's value
084: *
085: * @exception IllegalArgumentException if there is no property
086: * of the specified name
087: * @exception IllegalArgumentException if the specified property
088: * exists, but is not mapped
089: */
090: public Object get(String name, String key);
091:
092: /**
093: * Return the <code>DynaClass</code> instance that describes the set of
094: * properties available for this DynaBean.
095: *
096: * @return The associated DynaClass
097: */
098: public DynaClass getDynaClass();
099:
100: /**
101: * Remove any existing value for the specified key on the
102: * specified mapped property.
103: *
104: * @param name Name of the property for which a value is to
105: * be removed
106: * @param key Key of the value to be removed
107: *
108: * @exception IllegalArgumentException if there is no property
109: * of the specified name
110: */
111: public void remove(String name, String key);
112:
113: /**
114: * Set the value of a simple property with the specified name.
115: *
116: * @param name Name of the property whose value is to be set
117: * @param value Value to which this property is to be set
118: *
119: * @exception ConversionException if the specified value cannot be
120: * converted to the type required for this property
121: * @exception IllegalArgumentException if there is no property
122: * of the specified name
123: * @exception NullPointerException if an attempt is made to set a
124: * primitive property to null
125: */
126: public void set(String name, Object value);
127:
128: /**
129: * Set the value of an indexed property with the specified name.
130: *
131: * @param name Name of the property whose value is to be set
132: * @param index Index of the property to be set
133: * @param value Value to which this property is to be set
134: *
135: * @exception ConversionException if the specified value cannot be
136: * converted to the type required for this property
137: * @exception IllegalArgumentException if there is no property
138: * of the specified name
139: * @exception IllegalArgumentException if the specified property
140: * exists, but is not indexed
141: * @exception IndexOutOfBoundsException if the specified index
142: * is outside the range of the underlying property
143: */
144: public void set(String name, int index, Object value);
145:
146: /**
147: * Set the value of a mapped property with the specified name.
148: *
149: * @param name Name of the property whose value is to be set
150: * @param key Key of the property to be set
151: * @param value Value to which this property is to be set
152: *
153: * @exception ConversionException if the specified value cannot be
154: * converted to the type required for this property
155: * @exception IllegalArgumentException if there is no property
156: * of the specified name
157: * @exception IllegalArgumentException if the specified property
158: * exists, but is not mapped
159: */
160: public void set(String name, String key, Object value);
161:
162: }
|