|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectgroovy.lang.MetaClassImpl
groovy.lang.ExpandoMetaClass
public class ExpandoMetaClass
A MetaClass that implements GroovyObject and behaves like an Expando, allowing the addition of new methods on the fly
By default methods are only allowed to be added before initialize() is called. In other words you create a new
ExpandoMetaClass, add some methods and then call initialize(). If you attempt to add new methods after initialize()
has been called an error will be thrown.
This is to ensure that the MetaClass can operate appropriately in multi threaded environments as it forces you
to do all method additions at the beginning, before using the MetaClass.
If you need more fine grained control of how a method is matched you can use DynamicMethodsMetaClass
WARNING: This MetaClass uses a thread-bound ThreadLocal instance to store and retrieve properties.
In addition properties stored use soft references so they are both bound by the life of the Thread and by the soft
references. The implication here is you should NEVER use dynamic properties if you want their values to stick around
for long periods because as soon as the JVM is running low on memory or the thread dies they will be garbage collected.
// defines or replaces instance method:
metaClass.myMethod = { args -> }
// defines a new instance method
metaClass.myMethod << { args -> }
// creates multiple overloaded methods of the same name
metaClass.myMethod << { String s -> } << { Integer i -> }
// defines or replaces a static method with the 'static' qualifier
metaClass.'static'.myMethod = { args -> }
// defines a new static method with the 'static' qualifier
metaClass.'static'.myMethod << { args -> }
// defines a new constructor
metaClass.constructor << { String arg -> }
// defines or replaces a constructor
metaClass.constructor = { String arg -> }
// defines a new property with an initial value of "blah"
metaClass.myProperty = "blah"
| Nested Class Summary | |
|---|---|
protected class |
ExpandoMetaClass.ExpandoMetaConstructor
Handles the ability to use the left shift operator to append new constructors |
protected class |
ExpandoMetaClass.ExpandoMetaProperty
Instances of this class are returned when using the << left shift operator. |
| Nested classes/interfaces inherited from class groovy.lang.MetaClassImpl |
|---|
MetaClassImpl.Index |
| Field Summary | |
|---|---|
static String |
STATIC_QUALIFIER
|
| Fields inherited from class groovy.lang.MetaClassImpl |
|---|
EMPTY_CLASS_ARRAY, isGroovyObject, isMap, LOG, METHOD_MISSING, PROPERTY_MISSING, registry, STATIC_METHOD_MISSING, STATIC_PROPERTY_MISSING, theCachedClass, theClass |
| Constructor Summary | |
|---|---|
ExpandoMetaClass(Class theClass)
Constructs a new ExpandoMetaClass instance for the given class |
|
ExpandoMetaClass(Class theClass,
boolean register)
Constructs a new ExpandoMetaClass instance for the given class optionally placing the MetaClass in the MetaClassRegistry automatically |
|
ExpandoMetaClass(Class theClass,
boolean register,
boolean allowChangesAfterInit)
Constructs a new ExpandoMetaClass instance for the given class optionally placing the MetaClass in the MetaClassRegistry automatically |
|
| Method Summary | |
|---|---|
static void |
disableGlobally()
Call to disable the global use of ExpandoMetaClass |
static void |
enableGlobally()
Call to enable global use of global use of ExpandoMetaClass within the registry. |
List |
getExpandoMethods()
Returns a list of expando MetaMethod instances added to this ExpandoMetaClass |
Collection |
getExpandoProperties()
Returns a list of MetaBeanProperty instances added to this ExpandoMetaClass |
Class |
getJavaClass()
|
MetaClass |
getMetaClass()
Returns the metaclass for a given class. |
MetaProperty |
getMetaProperty(String name)
Looks up an existing MetaProperty by name |
List |
getMethods()
Overrides the behaviour of parent getMethods() method to make MetaClass aware of added Expando methods |
List |
getProperties()
Get all the properties defined for this type |
Object |
getProperty(Class sender,
Object object,
String name,
boolean useSuper,
boolean fromInsideClass)
Overrides default implementation just in case getProperty method has been overriden by ExpandoMetaClass |
Object |
getProperty(Object object,
String name)
Overrides default implementation just in case getProperty method has been overriden by ExpandoMetaClass |
Object |
getProperty(String property)
Retrieves a property value. |
String |
getPropertyForSetter(String setterName)
Returns a property name equivalent for the given setter name or null if it is not a getter |
protected LinkedList |
getSuperClasses()
Retrieves a list of super classes. |
boolean |
hasMetaMethod(String name,
Class[] args)
Checks whether a MetaMethod for the given name and arguments exists |
boolean |
hasMetaProperty(String name)
Returns true if the MetaClass has the given property |
void |
initialize()
complete the initlialisation process. |
Object |
invokeConstructor(Object[] arguments)
Invokes a constructor for the given arguments. |
Object |
invokeMethod(Class sender,
Object object,
String methodName,
Object[] originalArguments,
boolean isCallToSuper,
boolean fromInsideClass)
Overrides default implementation just in case invokeMethod has been overriden by ExpandoMetaClass |
Object |
invokeMethod(String name,
Object args)
Invokes the given method. |
Object |
invokeMissingMethod(Object instance,
String methodName,
Object[] arguments)
Overrides the default missing method behaviour and adds the capability to look up a method from super class |
Object |
invokeMissingProperty(Object instance,
String propertyName,
Object optionalValue,
boolean isGetter)
Overrides the default missing method behaviour and adds the capability to look up a method from the super class in the case where it has been overriden |
Object |
invokeStaticMethod(Object object,
String methodName,
Object[] arguments)
Overrides default implementation just in case a static invoke method has been set on ExpandoMetaClass |
protected boolean |
isInitialized()
|
boolean |
isModified()
Return whether the MetaClass has been modified or not |
boolean |
isSetter(String name,
CachedClass[] args)
|
protected void |
performOperationOnMetaClass(groovy.lang.ExpandoMetaClass.Callable c)
|
void |
refreshInheritedMethods(Set modifiedSuperExpandos)
Called from ExpandoMetaClassCreationHandle in the registry if it exists to setup inheritance handling |
protected void |
registerBeanProperty(String property,
Object newValue)
Registers a new bean property |
protected void |
registerInstanceMethod(String methodName,
Closure callable)
Registers a new instance method for the given method name and closure on this MetaClass |
protected void |
registerStaticMethod(String name,
Closure callable)
Registers a new static method for the given method name and closure on this MetaClass |
protected void |
setInitialized(boolean b)
|
void |
setMetaClass(MetaClass metaClass)
Allows the MetaClass to be replaced with a derived implementation. |
void |
setProperty(Class sender,
Object object,
String name,
Object newValue,
boolean useSuper,
boolean fromInsideClass)
Overrides default implementation just in case setProperty method has been overriden by ExpandoMetaClass |
void |
setProperty(String property,
Object newValue)
Sets the given property to the new value. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String STATIC_QUALIFIER
| Constructor Detail |
|---|
public ExpandoMetaClass(Class theClass)
theClass - The class that the MetaClass applies to
public ExpandoMetaClass(Class theClass,
boolean register)
theClass - The class that the MetaClass applies toregister - True if the MetaClass should be registered inside the MetaClassRegistry. This defaults to true and ExpandoMetaClass will effect all instances if changed
public ExpandoMetaClass(Class theClass,
boolean register,
boolean allowChangesAfterInit)
theClass - The class that the MetaClass applies toregister - True if the MetaClass should be registered inside the MetaClassRegistry. This defaults to true and ExpandoMetaClass will effect all instances if changedallowChangesAfterInit - Should the meta class be modifiable after initialization. Default is false.| Method Detail |
|---|
public Object invokeMissingMethod(Object instance,
String methodName,
Object[] arguments)
invokeMissingMethod in interface MetaClassinvokeMissingMethod in class MetaClassImplinstance - The instance to invoke methodMissing onmethodName - The name of the methodarguments - The arguments to the method
MetaClassImpl.invokeMissingMethod(Object, String, Object[])
public Object invokeMissingProperty(Object instance,
String propertyName,
Object optionalValue,
boolean isGetter)
invokeMissingProperty in interface MetaClassinvokeMissingProperty in class MetaClassImplinstance - The instance of the objectpropertyName - The property nameoptionalValue - The property value in the case of a setterisGetter - True if it is a getter
public boolean isModified()
MutableMetaClass
isModified in interface MutableMetaClassisModified in class MetaClassImplpublic static void enableGlobally()
public static void disableGlobally()
public void initialize()
MetaClass
initialize in interface MetaClassinitialize in class MetaClassImplprotected boolean isInitialized()
isInitialized in class MetaClassImplprotected void setInitialized(boolean b)
public Object invokeConstructor(Object[] arguments)
MetaObjectProtocol
invokeConstructor in interface MetaObjectProtocolinvokeConstructor in class MetaClassImplarguments - The arguments to the constructor
protected LinkedList getSuperClasses()
public MetaClass getMetaClass()
GroovyObject
getMetaClass in interface GroovyObjectpublic Object getProperty(String property)
GroovyObject
getProperty in interface GroovyObjectproperty - the name of the property of interest
public Object invokeMethod(String name,
Object args)
GroovyObject
invokeMethod in interface GroovyObjectname - the name of the method to callargs - the arguments to use for the method call
public void setMetaClass(MetaClass metaClass)
GroovyObject
setMetaClass in interface GroovyObjectmetaClass - the new metaclass
public void setProperty(String property,
Object newValue)
GroovyObject
setProperty in interface GroovyObjectproperty - the name of the property of interestnewValue - the new value for the propertyprotected void performOperationOnMetaClass(groovy.lang.ExpandoMetaClass.Callable c)
protected void registerBeanProperty(String property,
Object newValue)
property - The property namenewValue - The properties initial value
protected void registerInstanceMethod(String methodName,
Closure callable)
methodName - The method namecallable - The callable Closurepublic List getMethods()
getMethods in interface MetaClassgetMethods in interface MetaObjectProtocolgetMethods in class MetaClassImplMetaObjectProtocol.getMethods()public List getProperties()
MetaClassImpl
getProperties in interface MetaClassgetProperties in interface MetaObjectProtocolgetProperties in class MetaClassImplMetaProperty
protected void registerStaticMethod(String name,
Closure callable)
name - The method namecallable - The callable Closurepublic Class getJavaClass()
public void refreshInheritedMethods(Set modifiedSuperExpandos)
modifiedSuperExpandos - A list of modified super ExpandoMetaClasspublic List getExpandoMethods()
public Collection getExpandoProperties()
public Object invokeMethod(Class sender,
Object object,
String methodName,
Object[] originalArguments,
boolean isCallToSuper,
boolean fromInsideClass)
invokeMethod in interface MetaClassinvokeMethod in class MetaClassImplsender - The java.lang.Class instance that invoked the methodobject - The object which the method was invoked onmethodName - The name of the methodoriginalArguments - The arguments to the methodisCallToSuper - Whether the method is a call to a super class methodfromInsideClass - Whether the call was invoked from the inside or the outside of the class
MetaClassImpl.invokeMethod(Class, Object, String, Object[], boolean, boolean)
public Object invokeStaticMethod(Object object,
String methodName,
Object[] arguments)
invokeStaticMethod in interface MetaObjectProtocolinvokeStaticMethod in class MetaClassImplobject - An instance of the class returned by the getTheClass() method or the class itselfmethodName - The name of the methodarguments - The arguments to the method
MetaClassImpl.invokeStaticMethod(Object, String, Object[])
public Object getProperty(Class sender,
Object object,
String name,
boolean useSuper,
boolean fromInsideClass)
getProperty in interface MetaClassgetProperty in class MetaClassImplsender - The java.lang.Class instance that requested the propertyobject - The Object which the property is being retrieved fromname - The name of the propertyuseSuper - Whether the call is to a super class propertyfromInsideClass - ??
MetaClassImpl.getProperty(Class, Object, String, boolean, boolean)
public Object getProperty(Object object,
String name)
getProperty in interface MetaObjectProtocolgetProperty in class MetaClassImplobject - An instance of the class returned by the getTheClass() methodname - The name of the property to retrieve the value for
MetaClassImpl.getProperty(Object, String)
public void setProperty(Class sender,
Object object,
String name,
Object newValue,
boolean useSuper,
boolean fromInsideClass)
setProperty in interface MetaClasssetProperty in class MetaClassImplsender - The java.lang.Class instance that is mutating the propertyobject - The Object which the property is being set onname - The name of the propertynewValue - The new value of the property to setuseSuper - Whether the call is to a super class propertyfromInsideClass - ??MetaClassImpl.setProperty(Class, Object, String, Object, boolean, boolean)public MetaProperty getMetaProperty(String name)
getMetaProperty in interface MetaObjectProtocolgetMetaProperty in class MetaClassImplname - The name of the MetaProperty
MetaObjectProtocol.getMetaProperty(String)public boolean hasMetaProperty(String name)
name - The name of the MetaProperty
public boolean hasMetaMethod(String name,
Class[] args)
name - The name of the MetaMethodargs - The arguments to the meta method
public String getPropertyForSetter(String setterName)
setterName - The setter name
public boolean isSetter(String name,
CachedClass[] args)
|
Copyright © 2003-2008 The Codehaus. All rights reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||