ExpandoMetaClass (groovy 2.4.4 API)

groovy.lang.ExpandoMetaClass

All Implemented Interfaces and Traits:

GroovyObject
```
public class ExpandoMetaClass
extends MetaClassImpl
```
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`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.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CONSTRUCTOR`
`static String`	`STATIC_QUALIFIER`
`boolean`	`inRegistry`

Inherited fields
Fields inherited from class	Fields
`class MetaClassImpl`	`EMPTY_ARGUMENTS, INVOKE_METHOD_METHOD, METHOD_MISSING, PROPERTY_MISSING, STATIC_METHOD_MISSING, STATIC_PROPERTY_MISSING, getPropertyMethod, invokeMethodMethod, isGroovyObject, isMap, metaMethodIndex, registry, setPropertyMethod, theCachedClass, theClass`

Constructor Summary

Constructors
Constructor and description
`ExpandoMetaClass (Class theClass, boolean register, boolean allowChangesAfterInit, MetaMethod[] add)`
`ExpandoMetaClass (MetaClassRegistry registry, Class theClass, boolean register, boolean allowChangesAfterInit, MetaMethod[] add)`
`ExpandoMetaClass (Class theClass)` Constructs a new ExpandoMetaClass instance for the given class
`ExpandoMetaClass (Class theClass, MetaMethod[] add)`
`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, MetaMethod[] add)`
`ExpandoMetaClass (Class theClass, boolean register, boolean allowChangesAfterInit)` Constructs a new ExpandoMetaClass instance for the given class optionally placing the MetaClass in the MetaClassRegistry automatically

Methods Summary

Methods
Type	Name and description
`void`	`addMixinClass(MixinInMetaClass mixin)`
`Object`	`castToMixedType(Object obj, Class type)`
`protected void`	`checkInitalised()`
`CallSite`	`createConstructorSite(CallSite site, Object[] args)`
`CallSite`	`createPogoCallCurrentSite(CallSite site, Class sender, String name, Object[] args)`
`CallSite`	`createPogoCallSite(CallSite site, Object[] args)`
`CallSite`	`createPojoCallSite(CallSite site, Object receiver, Object[] args)`
`CallSite`	`createStaticSite(CallSite site, Object[] args)`
`ExpandoMetaClass`	`define(Closure closure)`
`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.
`MetaMethod`	`findMixinMethod(String methodName, Class[] arguments)`
`List<MetaMethod>`	`getExpandoMethods()` Returns a list of expando MetaMethod instances added to this ExpandoMetaClass
`Collection<MetaProperty>`	`getExpandoProperties()` Returns a list of MetaBeanProperty instances added to this ExpandoMetaClass
`Collection`	`getExpandoSubclassMethods()`
`Class`	`getJavaClass()` @return The Java class enhanced by this MetaClass
`MetaClass`	`getMetaClass()`
`MetaProperty`	`getMetaProperty(String name)` Looks up an existing MetaProperty by name
`List<MetaMethod>`	`getMethods()` Overrides the behavior of parent getMethods() method to make MetaClass aware of added Expando methods
`List<MetaProperty>`	`getProperties()`
`Object`	`getProperty(String property)`
`Object`	`getProperty(Class sender, Object object, String name, boolean useSuper, boolean fromInsideClass)` Overrides default implementation just in case getProperty method has been overridden by ExpandoMetaClass
`Object`	`getProperty(Object object, String name)` Overrides default implementation just in case getProperty method has been overridden by ExpandoMetaClass
`String`	`getPropertyForSetter(String setterName)` Returns a property name equivalent for the given setter name or null if it is not a getter
`protected Object`	`getSubclassMetaMethods(String methodName)`
`boolean`	`hasCustomStaticInvokeMethod()`
`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()`
`Object`	`invokeConstructor(Object[] arguments)`
`Object`	`invokeMethod(String name, Object args)`
`Object`	`invokeMethod(Class sender, Object object, String methodName, Object[] originalArguments, boolean isCallToSuper, boolean fromInsideClass)` Overrides default implementation just in case invokeMethod has been overridden by ExpandoMetaClass
`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()` Checks if the meta class is initialized.
`boolean`	`isModified()`
`boolean`	`isSetter(String name, CachedClass[] args)`
`static boolean`	`isValidExpandoProperty(String property)`
`protected void`	`onGetPropertyFoundInHierarchy(MetaMethod method)`
`protected void`	`onInvokeMethodFoundInHierarchy(MetaMethod method)`
`protected void`	`onSetPropertyFoundInHierarchy(MetaMethod method)`
`protected void`	`onSuperMethodFoundInHierarchy(MetaMethod method)`
`protected void`	`onSuperPropertyFoundInHierarchy(MetaBeanProperty property)`
`protected void`	`performOperationOnMetaClass(ExpandoMetaClass.Callable c)`
`void`	`refreshInheritedMethods(Set modifiedSuperExpandos)` Called from ExpandoMetaClassCreationHandle in the registry if it exists to set up inheritance handling
`void`	`registerBeanProperty(String property, Object newValue)` Registers a new bean property
`void`	`registerInstanceMethod(MetaMethod metaMethod)` Registers a new instance method for the given method name and closure on this MetaClass
`void`	`registerInstanceMethod(String name, Closure closure)`
`protected void`	`registerStaticMethod(String name, Closure callable)`
`protected void`	`registerStaticMethod(String name, Closure callable, Class[] paramTypes)` Registers a new static method for the given method name and closure on this MetaClass
`void`	`registerSubclassInstanceMethod(String name, Class klazz, Closure closure)`
`void`	`registerSubclassInstanceMethod(MetaMethod metaMethod)`
`MetaMethod`	`retrieveConstructor(Object[] args)`
`protected void`	`setInitialized(boolean b)`
`void`	`setMetaClass(MetaClass metaClass)`
`void`	`setProperty(String property, Object newValue)`
`void`	`setProperty(Class sender, Object object, String name, Object newValue, boolean useSuper, boolean fromInsideClass)` Overrides default implementation just in case setProperty method has been overridden by ExpandoMetaClass

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class MetaClassImpl`	addMetaBeanProperty, addMetaMethod, addMetaMethodToIndex, addNewInstanceMethod, addNewStaticMethod, applyPropertyDescriptors, checkIfGroovyObjectMethod, checkInitalised, chooseMethod, clearInvocationCaches, createConstructorSite, createPogoCallCurrentSite, createPogoCallSite, createPojoCallSite, createStaticSite, dropMethodCache, dropStaticMethodCache, findMethodInClassHierarchy, findMixinMethod, findOwnMethod, findPropertyInClassHierarchy, getAdditionalMetaMethods, getAttribute, getAttribute, getAttribute, getClassInfo, getClassNode, getEffectiveGetMetaProperty, getMetaMethod, getMetaMethods, getMetaProperty, getMethodWithCaching, getMethodWithoutCaching, getMethods, getProperties, getProperty, getProperty, getRegistry, getStaticMetaMethod, getSubclassMetaMethods, getSuperClasses, getTheCachedClass, getTheClass, getVersion, hasCustomInvokeMethod, hasCustomStaticInvokeMethod, hasProperty, incVersion, initialize, invokeConstructor, invokeMethod, invokeMethod, invokeMethod, invokeMissingMethod, invokeMissingProperty, invokeStaticMethod, invokeStaticMissingProperty, isGroovyObject, isInitialized, isModified, onGetPropertyFoundInHierarchy, onInvokeMethodFoundInHierarchy, onMixinMethodFound, onSetPropertyFoundInHierarchy, onSuperMethodFoundInHierarchy, onSuperPropertyFoundInHierarchy, pickMethod, respondsTo, respondsTo, retrieveConstructor, retrieveConstructor, retrieveStaticMethod, selectConstructorAndTransformArguments, setAttribute, setAttribute, setProperties, setProperty, setProperty, toString
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final String CONSTRUCTOR
  - public static final String STATIC_QUALIFIER
  - public boolean inRegistry
- Constructor Detail
  - public ExpandoMetaClass(Class theClass, boolean register, boolean allowChangesAfterInit, MetaMethod[] add)
  - public ExpandoMetaClass(MetaClassRegistry registry, Class theClass, boolean register, boolean allowChangesAfterInit, MetaMethod[] add)
  - public ExpandoMetaClass(Class theClass)
    
    Constructs a new ExpandoMetaClass instance for the given class
    Parameters:
    theClass - The class that the MetaClass applies to
  - public ExpandoMetaClass(Class theClass, MetaMethod[] add)
  - public ExpandoMetaClass(Class theClass, boolean register)
    
    Constructs a new ExpandoMetaClass instance for the given class optionally placing the MetaClass in the MetaClassRegistry automatically
    Parameters:
    theClass - The class that the MetaClass applies to
    register - 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, MetaMethod[] add)
  - public ExpandoMetaClass(Class theClass, boolean register, boolean allowChangesAfterInit)
    
    Constructs a new ExpandoMetaClass instance for the given class optionally placing the MetaClass in the MetaClassRegistry automatically
    Parameters:
    theClass - The class that the MetaClass applies to
    register - True if the MetaClass should be registered inside the MetaClassRegistry. This defaults to true and ExpandoMetaClass will effect all instances if changed
    allowChangesAfterInit - Should the meta class be modifiable after initialization. Default is false.
- Method Detail
  - public void addMixinClass(MixinInMetaClass mixin)
  - public Object castToMixedType(Object obj, Class type)
  - protected void checkInitalised()
  - public CallSite createConstructorSite(CallSite site, Object[] args)
  - public CallSite createPogoCallCurrentSite(CallSite site, Class sender, String name, Object[] args)
  - public CallSite createPogoCallSite(CallSite site, Object[] args)
  - public CallSite createPojoCallSite(CallSite site, Object receiver, Object[] args)
  - public CallSite createStaticSite(CallSite site, Object[] args)
  - public ExpandoMetaClass define(Closure closure)
  - public static void disableGlobally()
    
    Call to disable the global use of ExpandoMetaClass
  - public static void enableGlobally()
    
    Call to enable global use of global use of ExpandoMetaClass within the registry. This has the advantage that inheritance will function correctly, but has a higher memory usage on the JVM than normal Groovy
  - public MetaMethod findMixinMethod(String methodName, Class[] arguments)
  - public List<MetaMethod> getExpandoMethods()
    
    Returns a list of expando MetaMethod instances added to this ExpandoMetaClass
    Returns:
    the expandoMethods
  - public Collection<MetaProperty> getExpandoProperties()
    
    Returns a list of MetaBeanProperty instances added to this ExpandoMetaClass
    Returns:
    the expandoProperties
  - public Collection getExpandoSubclassMethods()
  - public Class getJavaClass()
    
    Returns:
    The Java class enhanced by this MetaClass
  - public MetaClass getMetaClass()
  - public MetaProperty getMetaProperty(String name)
    
    Looks up an existing MetaProperty by name
    Parameters:
    name - The name of the MetaProperty
    Returns:
    The MetaProperty or null if it doesn't exist
  - public List<MetaMethod> getMethods()
    
    Overrides the behavior of parent getMethods() method to make MetaClass aware of added Expando methods
    Returns:
    A list of MetaMethods
    See Also:
    MetaObjectProtocol.getMethods
  - public List<MetaProperty> getProperties()
  - public Object getProperty(String property)
  - public Object getProperty(Class sender, Object object, String name, boolean useSuper, boolean fromInsideClass)
    
    Overrides default implementation just in case getProperty method has been overridden by ExpandoMetaClass
    See Also:
    MetaClassImpl.getProperty
  - public Object getProperty(Object object, String name)
    
    Overrides default implementation just in case getProperty method has been overridden by ExpandoMetaClass
    See Also:
    MetaClassImpl.getProperty
  - public String getPropertyForSetter(String setterName)
    
    Returns a property name equivalent for the given setter name or null if it is not a getter
    Parameters:
    setterName - The setter name
    Returns:
    The property name equivalent
  - protected Object getSubclassMetaMethods(String methodName)
  - public boolean hasCustomStaticInvokeMethod()
  - public boolean hasMetaMethod(String name, Class[] args)
    
    Checks whether a MetaMethod for the given name and arguments exists
    Parameters:
    name - The name of the MetaMethod
    args - The arguments to the meta method
    Returns:
    True if the method exists otherwise null
  - public boolean hasMetaProperty(String name)
    
    Returns true if the MetaClass has the given property
    Parameters:
    name - The name of the MetaProperty
    Returns:
    True it exists as a MetaProperty
  - public void initialize()
  - public Object invokeConstructor(Object[] arguments)
  - public Object invokeMethod(String name, Object args)
  - public Object invokeMethod(Class sender, Object object, String methodName, Object[] originalArguments, boolean isCallToSuper, boolean fromInsideClass)
    
    Overrides default implementation just in case invokeMethod has been overridden by ExpandoMetaClass
    See Also:
    MetaClassImpl.invokeMethod
  - public Object invokeStaticMethod(Object object, String methodName, Object[] arguments)
    
    Overrides default implementation just in case a static invoke method has been set on ExpandoMetaClass
    See Also:
    MetaClassImpl.invokeStaticMethod
  - protected boolean isInitialized()
    
    Checks if the meta class is initialized.
    See Also:
    MetaClassImpl.isInitialized
  - public boolean isModified()
  - public boolean isSetter(String name, CachedClass[] args)
  - public static boolean isValidExpandoProperty(String property)
  - protected void onGetPropertyFoundInHierarchy(MetaMethod method)
  - protected void onInvokeMethodFoundInHierarchy(MetaMethod method)
  - protected void onSetPropertyFoundInHierarchy(MetaMethod method)
  - protected void onSuperMethodFoundInHierarchy(MetaMethod method)
  - protected void onSuperPropertyFoundInHierarchy(MetaBeanProperty property)
  - protected void performOperationOnMetaClass(ExpandoMetaClass.Callable c)
  - public void refreshInheritedMethods(Set modifiedSuperExpandos)
    
    Called from ExpandoMetaClassCreationHandle in the registry if it exists to set up inheritance handling
    Parameters:
    modifiedSuperExpandos - A list of modified super ExpandoMetaClass
  - public void registerBeanProperty(String property, Object newValue)
    
    Registers a new bean property
    Parameters:
    property - The property name
    newValue - The properties initial value
  - public void registerInstanceMethod(MetaMethod metaMethod)
    
    Registers a new instance method for the given method name and closure on this MetaClass
    Parameters:
    metaMethod
  - public void registerInstanceMethod(String name, Closure closure)
  - protected void registerStaticMethod(String name, Closure callable)
  - protected void registerStaticMethod(String name, Closure callable, Class[] paramTypes)
    
    Registers a new static method for the given method name and closure on this MetaClass
    Parameters:
    name - The method name
    callable - The callable Closure
  - public void registerSubclassInstanceMethod(String name, Class klazz, Closure closure)
  - public void registerSubclassInstanceMethod(MetaMethod metaMethod)
  - @Override public MetaMethod retrieveConstructor(Object[] args)
  - protected void setInitialized(boolean b)
  - public void setMetaClass(MetaClass metaClass)
  - public void setProperty(String property, Object newValue)
  - public void setProperty(Class sender, Object object, String name, Object newValue, boolean useSuper, boolean fromInsideClass)
    
    Overrides default implementation just in case setProperty method has been overridden by ExpandoMetaClass
    See Also:
    MetaClassImpl.setProperty

| Detail:
Field
Constructor
Method

[Java] Class ExpandoMetaClass

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String CONSTRUCTOR

public static final String STATIC_QUALIFIER

public boolean inRegistry

Constructor Detail

public ExpandoMetaClass(Class theClass, boolean register, boolean allowChangesAfterInit, MetaMethod[] add)

public ExpandoMetaClass(MetaClassRegistry registry, Class theClass, boolean register, boolean allowChangesAfterInit, MetaMethod[] add)

public ExpandoMetaClass(Class theClass)

public ExpandoMetaClass(Class theClass, MetaMethod[] add)

public ExpandoMetaClass(Class theClass, boolean register)

public ExpandoMetaClass(Class theClass, boolean register, MetaMethod[] add)

public ExpandoMetaClass(Class theClass, boolean register, boolean allowChangesAfterInit)

Method Detail

public void addMixinClass(MixinInMetaClass mixin)

public Object castToMixedType(Object obj, Class type)

protected void checkInitalised()

public CallSite createConstructorSite(CallSite site, Object[] args)

public CallSite createPogoCallCurrentSite(CallSite site, Class sender, String name, Object[] args)

public CallSite createPogoCallSite(CallSite site, Object[] args)

public CallSite createPojoCallSite(CallSite site, Object receiver, Object[] args)

public CallSite createStaticSite(CallSite site, Object[] args)

public ExpandoMetaClass define(Closure closure)

public static void disableGlobally()

public static void enableGlobally()

public MetaMethod findMixinMethod(String methodName, Class[] arguments)

public List<MetaMethod> getExpandoMethods()

public Collection<MetaProperty> getExpandoProperties()

public Collection getExpandoSubclassMethods()

public Class getJavaClass()

public MetaClass getMetaClass()

public MetaProperty getMetaProperty(String name)

public List<MetaMethod> getMethods()

public List<MetaProperty> getProperties()

public Object getProperty(String property)

public Object getProperty(Class sender, Object object, String name, boolean useSuper, boolean fromInsideClass)

public Object getProperty(Object object, String name)

public String getPropertyForSetter(String setterName)

protected Object getSubclassMetaMethods(String methodName)

public boolean hasCustomStaticInvokeMethod()

public boolean hasMetaMethod(String name, Class[] args)

public boolean hasMetaProperty(String name)

public void initialize()

public Object invokeConstructor(Object[] arguments)

public Object invokeMethod(String name, Object args)

public Object invokeMethod(Class sender, Object object, String methodName, Object[] originalArguments, boolean isCallToSuper, boolean fromInsideClass)

public Object invokeStaticMethod(Object object, String methodName, Object[] arguments)

protected boolean isInitialized()

public boolean isModified()

public boolean isSetter(String name, CachedClass[] args)

public static boolean isValidExpandoProperty(String property)

protected void onGetPropertyFoundInHierarchy(MetaMethod method)

protected void onInvokeMethodFoundInHierarchy(MetaMethod method)

protected void onSetPropertyFoundInHierarchy(MetaMethod method)

protected void onSuperMethodFoundInHierarchy(MetaMethod method)

protected void onSuperPropertyFoundInHierarchy(MetaBeanProperty property)

protected void performOperationOnMetaClass(ExpandoMetaClass.Callable c)

public void refreshInheritedMethods(Set modifiedSuperExpandos)

public void registerBeanProperty(String property, Object newValue)

public void registerInstanceMethod(MetaMethod metaMethod)

public void registerInstanceMethod(String name, Closure closure)

protected void registerStaticMethod(String name, Closure callable)

protected void registerStaticMethod(String name, Closure callable, Class[] paramTypes)

public void registerSubclassInstanceMethod(String name, Class klazz, Closure closure)

public void registerSubclassInstanceMethod(MetaMethod metaMethod)

@Override public MetaMethod retrieveConstructor(Object[] args)

protected void setInitialized(boolean b)

public void setMetaClass(MetaClass metaClass)

public void setProperty(String property, Object newValue)

public void setProperty(Class sender, Object object, String name, Object newValue, boolean useSuper, boolean fromInsideClass)