View Javadoc

1   /*
2    * $Id: MetaProperty.java 4287 2006-12-01 13:00:13Z blackdrag $
3    *
4    * Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5    *
6    * Redistribution and use of this software and associated documentation
7    * ("Software"), with or without modification, are permitted provided that the
8    * following conditions are met:
9    *  1. Redistributions of source code must retain copyright statements and
10   * notices. Redistributions must also contain a copy of this document.
11   *  2. Redistributions in binary form must reproduce the above copyright
12   * notice, this list of conditions and the following disclaimer in the
13   * documentation and/or other materials provided with the distribution.
14   *  3. The name "groovy" must not be used to endorse or promote products
15   * derived from this Software without prior written permission of The Codehaus.
16   * For written permission, please contact info@codehaus.org.
17   *  4. Products derived from this Software may not be called "groovy" nor may
18   * "groovy" appear in their names without prior written permission of The
19   * Codehaus. "groovy" is a registered trademark of The Codehaus.
20   *  5. Due credit should be given to The Codehaus - http://groovy.codehaus.org/
21   *
22   * THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS ``AS IS'' AND ANY
23   * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25   * DISCLAIMED. IN NO EVENT SHALL THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR
26   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31   * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
32   * DAMAGE.
33   *
34   */
35  package groovy.lang;
36  
37  import java.lang.reflect.Modifier;
38  
39  /***
40   * Represents a property on a bean which may have a getter and/or a setter
41   * 
42   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
43   * @version $Revision: 4287 $
44   */
45  public abstract class MetaProperty {
46  
47      protected String name;
48      protected Class type;
49  
50      public MetaProperty(String name, Class type) {
51          this.name = name;
52          this.type = type;
53      }
54  
55      /***
56       * @return the property of the given object
57       * @throws Exception if the property could not be evaluated
58       */
59      public abstract Object getProperty(Object object);
60  
61      /***
62       * Sets the property on the given object to the new value
63       * 
64       * @param object on which to set the property
65       * @param newValue the new value of the property
66       * @throws RuntimeException if the property could not be set
67       */
68      public abstract void setProperty(Object object, Object newValue);
69  
70      public String getName() {
71          return name;
72      }
73  
74      /***
75       * @return the type of the property
76       */
77      public Class getType() {
78          return type;
79      }
80      
81      public int getModifiers() {
82          return Modifier.PUBLIC;
83      }
84  
85  }