View Javadoc

    1   /*
    2    * $Id: MetaBeanProperty.java 4445 2006-12-17 22:35:15Z 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  import org.codehaus.groovy.runtime.MetaClassHelper;
    40  import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
    41
    42  /***
    43   * Represents a property on a bean which may have a getter and/or a setter
    44   *
    45   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
    46   * @author Pilho Kim
    47   * @version $Revision: 4445 $
    48   */
    49  public class MetaBeanProperty extends MetaProperty {
    50
    51      private MetaMethod getter;
    52      private MetaMethod setter;
    53      private MetaFieldProperty field;
    54
    55      public MetaBeanProperty(String name, Class type, MetaMethod getter, MetaMethod setter) {
    56          super(name, type);
    57          this.getter = getter;
    58          this.setter = setter;
    59      }
    60
    61      /***
    62       * Get the property of the given object.
    63       *
    64       * @param object which to be got
    65       * @return the property of the given object
    66       * @throws Exception if the property could not be evaluated
    67       */
    68      public Object getProperty(Object object) {
    69          if (getter == null) {
    70              //TODO: we probably need a WriteOnlyException class
    71              throw new GroovyRuntimeException("Cannot read write-only property: " + name);
    72          }
    73          return getter.invoke(object, MetaClassHelper.EMPTY_ARRAY);
    74      }
    75
    76      /***
    77       * Set the property on the given object to the new value.
    78       *
    79       * @param object   on which to set the property
    80       * @param newValue the new value of the property
    81       * @throws RuntimeException if the property could not be set
    82       */
    83      public void setProperty(Object object, Object newValue) {
    84          if (setter == null) {
    85              throw new GroovyRuntimeException("Cannot set read-only property: " + name);
    86          }
    87          newValue = DefaultTypeTransformation.castToType(newValue, getType());
    88          setter.invoke(object, new Object[] { newValue });
    89      }
    90
    91      /***
    92       * Get the getter method.
    93       */
    94      public MetaMethod getGetter() {
    95          return getter;
    96      }
    97
    98      /***
    99       * Get the setter method.
    100      */
    101     public MetaMethod getSetter() {
    102         return setter;
    103     }
    104
    105     /***
    106      * This is for MetaClass to patch up the object later when looking for get*() methods.
    107      */
    108     void setGetter(MetaMethod getter) {
    109         this.getter = getter;
    110     }
    111
    112     /***
    113      * This is for MetaClass to patch up the object later when looking for set*() methods.
    114      */
    115     void setSetter(MetaMethod setter) {
    116         this.setter = setter;
    117     }
    118
    119     public int getModifiers() {
    120         if (setter!=null && getter==null) return setter.getModifiers();
    121         if (getter!=null && setter==null) return getter.getModifiers();
    122         int modifiers = getter.getModifiers() | setter.getModifiers();
    123         int visibility = 0;
    124         if (Modifier.isPublic(modifiers)) visibility = Modifier.PUBLIC;
    125         if (Modifier.isProtected(modifiers)) visibility = Modifier.PROTECTED;
    126         if (Modifier.isPrivate(modifiers)) visibility = Modifier.PRIVATE;
    127         int states = getter.getModifiers() & setter.getModifiers();
    128         states &= ~(Modifier.PUBLIC|Modifier.PROTECTED|Modifier.PRIVATE);
    129         states |= visibility;
    130         return states;
    131     }
    132
    133     public void setField(MetaFieldProperty f) {
    134         this.field = f;
    135     }
    136
    137     public MetaFieldProperty getField() {
    138         return field;
    139     }
    140 }