View Javadoc

1   /*
2    * $Id: MetaProperty.java,v 1.2 2004/07/13 19:43:07 jstrachan Exp $
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  /***
38   * Represents a property on a bean which may have a getter and/or a setter
39   * 
40   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
41   * @version $Revision: 1.2 $
42   */
43  public abstract class MetaProperty {
44  
45      protected String name;
46      protected Class type;
47  
48      public MetaProperty(String name, Class type) {
49          this.name = name;
50          this.type = type;
51      }
52  
53      /***
54       * @return the property of the given object
55       * @throws Exception if the property could not be evaluated
56       */
57      public abstract Object getProperty(Object object) throws Exception;
58  
59      /***
60       * Sets the property on the given object to the new value
61       * 
62       * @param object on which to set the property
63       * @param newValue the new value of the property
64       * @throws Exception if the property could not be set
65       */
66      public abstract void setProperty(Object object, Object newValue);
67  
68      public String getName() {
69          return name;
70      }
71  
72      /***
73       * @return the type of the property
74       */
75      public Class getType() {
76          return type;
77      }
78  
79  }