KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > utils > FieldPropertyDescriptor


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */

55
56 package org.jboss.axis.utils;
57
58 import java.beans.PropertyDescriptor JavaDoc;
59 import java.lang.reflect.Array JavaDoc;
60 import java.lang.reflect.Field JavaDoc;
61 import java.lang.reflect.InvocationTargetException JavaDoc;
62
63
64 /**
65  * @author Glen Daniels (gdaniels@apache.org)
66  */

67 public class FieldPropertyDescriptor extends BeanPropertyDescriptor
68 {
69    private Field JavaDoc field = null;
70
71    /**
72     * Construct a BPD with a field
73     * Both must be set
74     *
75     * @param _name is the name of the property
76     * @param _field is the name of the public instance field
77     */

78    public FieldPropertyDescriptor(String JavaDoc _name,
79                                   Field JavaDoc _field)
80    {
81       field = _field;
82       try
83       {
84          myPD = new PropertyDescriptor JavaDoc(_name, null, null);
85       }
86       catch (Exception JavaDoc e)
87       {
88          // ???
89
}
90       if (_field == null || _name == null)
91       {
92          throw new IllegalArgumentException JavaDoc(Messages.getMessage(_field == null ?
93                  "badField00" : "badProp03"));
94       }
95    }
96
97    public String JavaDoc getName()
98    {
99       return field.getName();
100    }
101
102    /**
103     * Query if property is readable
104     *
105     * @return true if readable
106     */

107    public boolean isReadable()
108    {
109       return true;
110    }
111
112    /**
113     * Query if property is writeable
114     *
115     * @return true if writeable
116     */

117    public boolean isWriteable()
118    {
119       return true;
120    }
121
122    /**
123     * Query if property is indexed.
124     * Indexed properties require valid setters/getters
125     *
126     * @return true if indexed methods exist
127     */

128    public boolean isIndexed()
129    {
130       return (field.getType().getComponentType() != null);
131    }
132
133    /**
134     * Get the property value
135     *
136     * @param obj is the object
137     * @return the entire propery value
138     */

139    public Object JavaDoc get(Object JavaDoc obj)
140            throws InvocationTargetException JavaDoc, IllegalAccessException JavaDoc
141    {
142       return field.get(obj);
143    }
144
145    /**
146     * Set the property value
147     *
148     * @param obj is the object
149     * @param newValue is the new value
150     */

151    public void set(Object JavaDoc obj, Object JavaDoc newValue)
152            throws InvocationTargetException JavaDoc, IllegalAccessException JavaDoc
153    {
154       field.set(obj, newValue);
155    }
156
157    /**
158     * Get an indexed property
159     *
160     * @param obj is the object
161     * @param i the index
162     * @return the object at the indicated index
163     */

164    public Object JavaDoc get(Object JavaDoc obj, int i)
165            throws InvocationTargetException JavaDoc, IllegalAccessException JavaDoc
166    {
167       if (!isIndexed())
168       {
169          throw new IllegalAccessException JavaDoc("Not an indexed property");
170       }
171
172       Object JavaDoc array = field.get(obj);
173       return Array.get(array, i);
174    }
175
176    /**
177     * Set an indexed property value
178     *
179     * @param obj is the object
180     * @param i the index
181     * @param newValue is the new value
182     */

183    public void set(Object JavaDoc obj, int i, Object JavaDoc newValue)
184            throws InvocationTargetException JavaDoc, IllegalAccessException JavaDoc
185    {
186       if (!isIndexed())
187       {
188          throw new IllegalAccessException JavaDoc("Not an indexed field!");
189       }
190       Class JavaDoc componentType = field.getType().getComponentType();
191       growArrayToSize(obj, componentType, i);
192       Array.set(get(obj), i, newValue);
193    }
194
195    /**
196     * Get the type of a property
197     *
198     * @return the type of the property
199     */

200    public Class JavaDoc getType()
201    {
202       if (isIndexed())
203       {
204          return field.getType().getComponentType();
205       }
206       else
207       {
208          return field.getType();
209       }
210    }
211 }
212
Popular Tags