001 /* 002 * $Id: MetaBeanProperty.java 4445 2006-12-17 22:35:15Z blackdrag $ 003 * 004 * Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved. 005 * 006 * Redistribution and use of this software and associated documentation 007 * ("Software"), with or without modification, are permitted provided that the 008 * following conditions are met: 009 * 1. Redistributions of source code must retain copyright statements and 010 * notices. Redistributions must also contain a copy of this document. 011 * 2. Redistributions in binary form must reproduce the above copyright 012 * notice, this list of conditions and the following disclaimer in the 013 * documentation and/or other materials provided with the distribution. 014 * 3. The name "groovy" must not be used to endorse or promote products 015 * derived from this Software without prior written permission of The Codehaus. 016 * For written permission, please contact info@codehaus.org. 017 * 4. Products derived from this Software may not be called "groovy" nor may 018 * "groovy" appear in their names without prior written permission of The 019 * Codehaus. "groovy" is a registered trademark of The Codehaus. 020 * 5. Due credit should be given to The Codehaus - http://groovy.codehaus.org/ 021 * 022 * THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS ``AS IS'' AND ANY 023 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 024 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 025 * DISCLAIMED. IN NO EVENT SHALL THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR 026 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 027 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 028 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 029 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 030 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 031 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 032 * DAMAGE. 033 * 034 */ 035 package groovy.lang; 036 037 import java.lang.reflect.Modifier; 038 039 import org.codehaus.groovy.runtime.MetaClassHelper; 040 import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation; 041 042 /** 043 * Represents a property on a bean which may have a getter and/or a setter 044 * 045 * @author <a href="mailto:james@coredevelopers.net">James Strachan</a> 046 * @author Pilho Kim 047 * @version $Revision: 4445 $ 048 */ 049 public class MetaBeanProperty extends MetaProperty { 050 051 private MetaMethod getter; 052 private MetaMethod setter; 053 private MetaFieldProperty field; 054 055 public MetaBeanProperty(String name, Class type, MetaMethod getter, MetaMethod setter) { 056 super(name, type); 057 this.getter = getter; 058 this.setter = setter; 059 } 060 061 /** 062 * Get the property of the given object. 063 * 064 * @param object which to be got 065 * @return the property of the given object 066 * @throws Exception if the property could not be evaluated 067 */ 068 public Object getProperty(Object object) { 069 if (getter == null) { 070 //TODO: we probably need a WriteOnlyException class 071 throw new GroovyRuntimeException("Cannot read write-only property: " + name); 072 } 073 return getter.invoke(object, MetaClassHelper.EMPTY_ARRAY); 074 } 075 076 /** 077 * Set the property on the given object to the new value. 078 * 079 * @param object on which to set the property 080 * @param newValue the new value of the property 081 * @throws RuntimeException if the property could not be set 082 */ 083 public void setProperty(Object object, Object newValue) { 084 if (setter == null) { 085 throw new GroovyRuntimeException("Cannot set read-only property: " + name); 086 } 087 newValue = DefaultTypeTransformation.castToType(newValue, getType()); 088 setter.invoke(object, new Object[] { newValue }); 089 } 090 091 /** 092 * Get the getter method. 093 */ 094 public MetaMethod getGetter() { 095 return getter; 096 } 097 098 /** 099 * 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 }