001: /*
002: $Id: Expando.java 4578 2006-12-22 11:59:52Z 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
008: that the following conditions are met:
009:
010: 1. Redistributions of source code must retain copyright
011: statements and notices. Redistributions must also contain a
012: copy of this document.
013:
014: 2. Redistributions in binary form must reproduce the
015: above copyright notice, this list of conditions and the
016: following disclaimer in the documentation and/or other
017: materials provided with the distribution.
018:
019: 3. The name "groovy" must not be used to endorse or promote
020: products derived from this Software without prior written
021: permission of The Codehaus. For written permission,
022: please contact info@codehaus.org.
023:
024: 4. Products derived from this Software may not be called "groovy"
025: nor may "groovy" appear in their names without prior written
026: permission of The Codehaus. "groovy" is a registered
027: trademark of The Codehaus.
028:
029: 5. Due credit should be given to The Codehaus -
030: http://groovy.codehaus.org/
031:
032: THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
033: ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
034: NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
035: FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
036: THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
037: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
038: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
039: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
040: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
041: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
042: ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
043: OF THE POSSIBILITY OF SUCH DAMAGE.
044:
045: */
046: package groovy.util;
047:
048: import groovy.lang.Closure;
049: import groovy.lang.GroovyObjectSupport;
050: import groovy.lang.GroovyRuntimeException;
051: import groovy.lang.MetaExpandoProperty;
052: import groovy.lang.MissingPropertyException;
053:
054: import java.util.HashMap;
055: import java.util.Map;
056: import java.util.Map.Entry;
057: import java.util.List;
058: import java.util.ArrayList;
059: import java.util.Iterator;
060:
061: /**
062: * Represents a dynamically expandable bean.
063: *
064: * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
065: * @author Hein Meling
066: * @author Pilho Kim
067: * @version $Revision: 4578 $
068: */
069: public class Expando extends GroovyObjectSupport {
070:
071: private Map expandoProperties;
072:
073: public Expando() {
074: }
075:
076: public Expando(Map expandoProperties) {
077: this .expandoProperties = expandoProperties;
078: }
079:
080: /**
081: * @return the dynamically expanded properties
082: */
083: public Map getProperties() {
084: if (expandoProperties == null) {
085: expandoProperties = createMap();
086: }
087: return expandoProperties;
088: }
089:
090: public List getMetaPropertyValues() {
091: // run through all our current properties and create MetaProperty objects
092: List ret = new ArrayList();
093: Iterator itr = getProperties().entrySet().iterator();
094: while (itr.hasNext()) {
095: Entry entry = (Entry) itr.next();
096: ret.add(new MetaExpandoProperty(entry));
097: }
098:
099: return ret;
100: }
101:
102: public Object getProperty(String property) {
103: // always use the expando properties first
104: Object result = getProperties().get(property);
105: if (result != null)
106: return result;
107: try {
108: return super .getProperty(property);
109: } catch (MissingPropertyException e) {
110: }
111: return null;
112: }
113:
114: public void setProperty(String property, Object newValue) {
115: // always use the expando properties
116: getProperties().put(property, newValue);
117: }
118:
119: public Object invokeMethod(String name, Object args) {
120: try {
121: return super .invokeMethod(name, args);
122: } catch (GroovyRuntimeException e) {
123: // br should get a "native" property match first. getProperty includes such fall-back logic
124: Object value = this .getProperty(name);
125: if (value instanceof Closure) {
126: Closure closure = (Closure) value;
127: closure.setDelegate(this );
128: return closure.call((Object[]) args);
129: } else {
130: throw e;
131: }
132: }
133:
134: }
135:
136: /**
137: * This allows toString to be overridden by a closure <i>field</i> method attached
138: * to the expando object.
139: *
140: * @see java.lang.Object#toString()
141: */
142: public String toString() {
143: Object method = getProperties().get("toString");
144: if (method != null && method instanceof Closure) {
145: // invoke overridden toString closure method
146: Closure closure = (Closure) method;
147: closure.setDelegate(this );
148: return closure.call().toString();
149: } else {
150: return expandoProperties.toString();
151: }
152: }
153:
154: /**
155: * This allows equals to be overridden by a closure <i>field</i> method attached
156: * to the expando object.
157: *
158: * @see java.lang.Object#equals(java.lang.Object)
159: */
160: public boolean equals(Object obj) {
161: Object method = getProperties().get("equals");
162: if (method != null && method instanceof Closure) {
163: // invoke overridden equals closure method
164: Closure closure = (Closure) method;
165: closure.setDelegate(this );
166: Boolean ret = (Boolean) closure.call(obj);
167: return ret.booleanValue();
168: } else {
169: return super .equals(obj);
170: }
171: }
172:
173: /**
174: * This allows hashCode to be overridden by a closure <i>field</i> method attached
175: * to the expando object.
176: *
177: * @see java.lang.Object#hashCode()
178: */
179: public int hashCode() {
180: Object method = getProperties().get("hashCode");
181: if (method != null && method instanceof Closure) {
182: // invoke overridden hashCode closure method
183: Closure closure = (Closure) method;
184: closure.setDelegate(this );
185: Integer ret = (Integer) closure.call();
186: return ret.intValue();
187: } else {
188: return super .hashCode();
189: }
190: }
191:
192: /**
193: * Factory method to create a new Map used to store the expando properties map
194: * @return a newly created Map implementation
195: */
196: protected Map createMap() {
197: return new HashMap();
198: }
199:
200: }
|