Package org.codehaus.groovy.runtime.metaclass

# Class ClosureMetaClass

java.lang.Object
groovy.lang.MetaClassImpl
org.codehaus.groovy.runtime.metaclass.ClosureMetaClass

All Implemented Interfaces:
  `MetaClass`, `MetaObjectProtocol`, `MutableMetaClass`

public final class ClosureMetaClass extends MetaClassImpl
A meta class for closures generated by the Groovy compiler. These classes have special characteristics this MetaClass uses. One of these is that a generated Closure has only additional doCall methods, all other methods are in the Closure class as well. To use this fact this MetaClass uses a MetaClass for Closure as static field And delegates calls to this MetaClass if needed. This allows a lean implementation for this MetaClass. Multiple generated closures will then use the same MetaClass for Closure. For static dispatching this class uses the MetaClass of Class, again all instances of this class will share that MetaClass. The Class MetaClass is initialized lazy, because most operations do not need this MetaClass.

The Closure and Class MetaClasses are not replaceable.

This MetaClass is for internal usage only!

Since:
  1.5

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class groovy.lang.MetaClassImpl

  `MetaClassImpl.Index, MetaClassImpl.MetaConstructor`

- ## Field Summary

  ### Fields inherited from class groovy.lang.MetaClassImpl

  `getPropertyMethod, INVOKE_METHOD_METHOD, invokeMethodMethod, isGroovyObject, isMap, metaMethodIndex, METHOD_MISSING, PROPERTY_MISSING, registry, setPropertyMethod, STATIC_METHOD_MISSING, STATIC_PROPERTY_MISSING, theCachedClass, theClass`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ClosureMetaClass(MetaClassRegistry registry, Class theClass)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addMetaBeanProperty(MetaBeanProperty mp)`
  Adds a new MetaBeanProperty to this MetaClass
  `void`
  `addMetaMethod(MetaMethod method)`
  adds a MetaMethod to this class.
  `void`
  `addNewInstanceMethod(Method method)`
  Adds an instance method to this metaclass.
  `void`
  `addNewStaticMethod(Method method)`
  Adds a static method to this metaclass.
  `protected void`
  `applyPropertyDescriptors(PropertyDescriptor[] propertyDescriptors)`
  `CallSite`
  `createPogoCallCurrentSite(CallSite site, Class sender, Object[] args)`
  Create a CallSite
  `CallSite`
  `createPogoCallSite(CallSite site, Object[] args)`
  Create a CallSite
  `CallSite`
  `createPojoCallSite(CallSite site, Object receiver, Object[] args)`
  Create a CallSite
  `Object`
  `getAttribute(Class sender, Object object, String attribute, boolean useSuper, boolean fromInsideClass)`
  Retrieves the value of an attribute (field).
  `List<MetaMethod>`
  `getMetaMethods()`
  Retrieves the list of MetaMethods held by this class.
  `MetaProperty`
  `getMetaProperty(String name)`
  Returns a MetaProperty for the given name or null if it doesn't exist
  `List<MetaMethod>`
  `getMethods()`
  Retrieves the list of MetaMethods held by the class.
  `MetaMethod`
  `getMethodWithoutCaching(int index, Class sender, String methodName, Class[] arguments, boolean isCallToSuper)`
  `List<MetaProperty>`
  `getProperties()`
  Get all the properties defined for this type
  `Object`
  `getProperty(Class sender, Object object, String name, boolean useSuper, boolean fromInsideClass)`
  Retrieves a property on the given receiver for the specified arguments.
  `MetaMethod`
  `getStaticMetaMethod(String name, Class[] argTypes)`
  `MetaMethod`
  `getStaticMetaMethod(String name, Object[] args)`
  Retrieves a static MetaMethod for the given name and argument values, using the types of the arguments to establish the chosen MetaMethod
  `void`
  `initialize()`
  Complete the initialisation process.
  `Object`
  `invokeMethod(Class sender, Object object, String methodName, Object[] originalArguments, boolean isCallToSuper, boolean fromInsideClass)`
  Invokes a method on the given receiver for the specified arguments.
  `Object`
  `invokeStaticMethod(Object object, String methodName, Object[] arguments)`
  Invokes a static method on the given Object with the given name and arguments.
  `protected boolean`
  `isInitialized()`
  `MetaMethod`
  `pickMethod(String methodName, Class[] argumentTypes)`
  Selects a method by name and argument classes.
  `static void`
  `resetCachedMetaClasses()`
  `List`
  `respondsTo(Object obj, String name)`
  Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name regardless of arguments.
  `List`
  `respondsTo(Object obj, String name, Object[] argTypes)`
  Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name and arguments types.
  `Constructor`
  `retrieveConstructor(Class[] arguments)`
  `MetaMethod`
  `retrieveStaticMethod(String methodName, Class[] arguments)`
  `void`
  `setAttribute(Class sender, Object object, String attribute, Object newValue, boolean useSuper, boolean fromInsideClass)`
  Sets an attribute on the given receiver for the specified arguments.
  `protected void`
  `setInitialized(boolean initialized)`
  `void`
  `setProperties(Object bean, Map map)`
  Sets a number of bean properties from the given Map where the keys are the String names of properties and the values are the values of the properties to set
  `void`
  `setProperty(Class sender, Object object, String name, Object newValue, boolean useSuper, boolean fromInsideClass)`
  Retrieves a property on the given receiver for the specified arguments.

  ### Methods inherited from class groovy.lang.MetaClassImpl

  `addMetaMethodToIndex, checkIfGroovyObjectMethod, checkInitalised, chooseMethod, clearInvocationCaches, createConstructorSite, createErrorMessageForAmbiguity, createStaticSite, createTransformMetaMethod, doChooseMostSpecificParams, dropMethodCache, dropStaticMethodCache, findMethodInClassHierarchy, findMixinMethod, findOwnMethod, findPropertyInClassHierarchy, getAdditionalMetaMethods, getAttribute, getAttribute, getClassInfo, getClassNode, getEffectiveGetMetaProperty, getMetaMethod, getMethodWithCaching, getMethodWithoutCaching, getProperty, getRegistry, getSubclassMetaMethods, getSuperClasses, getTheCachedClass, getTheClass, getVersion, handleMatches, hasCustomInvokeMethod, hasCustomStaticInvokeMethod, hasProperty, incVersion, invokeConstructor, invokeMethod, invokeMethod, invokeMissingMethod, invokeMissingProperty, invokeStaticMissingProperty, isGroovyObject, isModified, isPermissivePropertyAccess, onGetPropertyFoundInHierarchy, onInvokeMethodFoundInHierarchy, onMixinMethodFound, onSetPropertyFoundInHierarchy, onSuperMethodFoundInHierarchy, onSuperPropertyFoundInHierarchy, reinitialize, retrieveConstructor, retrieveStaticMethod, selectConstructorAndTransformArguments, setAttribute, setPermissivePropertyAccess, setProperty, toString`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### ClosureMetaClass

    public ClosureMetaClass(MetaClassRegistry registry, Class theClass)

- ## Method Details

  - ### resetCachedMetaClasses

    public static void resetCachedMetaClasses()

  - ### getMetaProperty

    public MetaProperty getMetaProperty(String name)
    Description copied from interface: `MetaObjectProtocol`
    Returns a MetaProperty for the given name or null if it doesn't exist
    Specified by:
      `getMetaProperty` in interface `MetaObjectProtocol`
    Overrides:
      `getMetaProperty` in class `MetaClassImpl`
    Parameters:
      `name` - The name of the MetaProperty
    Returns:
      A MetaProperty or null
    See Also:
      - `MetaObjectProtocol.getMetaProperty(String)`

  - ### invokeMethod

    public Object invokeMethod(Class sender, Object object, String methodName, Object[] originalArguments, boolean isCallToSuper, boolean fromInsideClass)
    Description copied from class: `MetaClassImpl`
    Invokes a method on the given receiver for the specified arguments. The sender is the class that invoked the method on the object. The MetaClass will attempt to establish the method to invoke based on the name and arguments provided.

    The isCallToSuper and fromInsideClass help the Groovy runtime perform optimisations on the call to go directly to the super class if necessary

    Specified by:
      `invokeMethod` in interface `MetaClass`
    Overrides:
      `invokeMethod` in class `MetaClassImpl`
    Parameters:
      `sender` - The java.lang.Class instance that invoked the method
      `object` - The object which the method was invoked on
      `methodName` - The name of the method
      `originalArguments` - The arguments to the method
      `isCallToSuper` - Whether the method is a call to a super class method
      `fromInsideClass` - Whether the call was invoked from the inside or the outside of the class
    Returns:
      The return value of the method
    See Also:
      - `MetaClass.invokeMethod(Class, Object, String, Object[], boolean, boolean)`

  - ### initialize

    public void initialize()
    Description copied from class: `MetaClassImpl`
    Complete the initialisation process. After this method is called no methods should be added to the meta class. Invocation of methods or access to fields/properties is forbidden unless this method is called. This method should contain any initialisation code, taking a longer time to complete. An example is the creation of the Reflector. It is suggested to synchronize this method.
    Specified by:
      `initialize` in interface `MetaClass`
    Overrides:
      `initialize` in class `MetaClassImpl`

  - ### getMethods

    public List<MetaMethod> getMethods()
    Description copied from class: `MetaClassImpl`
    Retrieves the list of MetaMethods held by the class. This list does not include MetaMethods added by groovy.lang.ExpandoMetaClass.
    Specified by:
      `getMethods` in interface `MetaClass`
    Specified by:
      `getMethods` in interface `MetaObjectProtocol`
    Overrides:
      `getMethods` in class `MetaClassImpl`
    Returns:
      A list of MetaMethods
    See Also:
      - `MetaMethod`

  - ### getMetaMethods

    public List<MetaMethod> getMetaMethods()
    Description copied from class: `MetaClassImpl`
    Retrieves the list of MetaMethods held by this class. This list includes MetaMethods added by groovy.lang.ExpandoMetaClass.
    Specified by:
      `getMetaMethods` in interface `MetaClass`
    Overrides:
      `getMetaMethods` in class `MetaClassImpl`
    Returns:
      A list of MetaMethods

  - ### getProperties

    public List<MetaProperty> getProperties()
    Description copied from class: `MetaClassImpl`
    Get all the properties defined for this type
    Specified by:
      `getProperties` in interface `MetaClass`
    Specified by:
      `getProperties` in interface `MetaObjectProtocol`
    Overrides:
      `getProperties` in class `MetaClassImpl`
    Returns:
      a list of MetaProperty objects
    See Also:
      - `MetaProperty`

  - ### pickMethod

    public MetaMethod pickMethod(String methodName, Class[] argumentTypes)
    Description copied from class: `MetaClassImpl`
    Selects a method by name and argument classes. This method does not search for an exact match, it searches for a compatible method. For this the method selection mechanism is used as provided by the implementation of this MetaClass. pickMethod may or may not be used during the method selection process when invoking a method. There is no warranty for that.
    Specified by:
      `pickMethod` in interface `MetaClass`
    Overrides:
      `pickMethod` in class `MetaClassImpl`
    Parameters:
      `methodName` - the name of the method to pick
      `argumentTypes` - the method arguments
    Returns:
      a matching MetaMethod or null

  - ### retrieveStaticMethod

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

  - ### isInitialized

    protected boolean isInitialized()
    Overrides:
      `isInitialized` in class `MetaClassImpl`

  - ### setInitialized

    protected void setInitialized(boolean initialized)
    Overrides:
      `setInitialized` in class `MetaClassImpl`

  - ### getStaticMetaMethod

    public MetaMethod getStaticMetaMethod(String name, Object[] args)
    Description copied from interface: `MetaObjectProtocol`
    Retrieves a static MetaMethod for the given name and argument values, using the types of the arguments to establish the chosen MetaMethod
    Specified by:
      `getStaticMetaMethod` in interface `MetaObjectProtocol`
    Overrides:
      `getStaticMetaMethod` in class `MetaClassImpl`
    Parameters:
      `name` - The name of the MetaMethod
      `args` - The argument types
    Returns:
      A MetaMethod or null if it doesn't exist
    See Also:
      - `MetaObjectProtocol.getStaticMetaMethod(String, Object[])`

  - ### getStaticMetaMethod

    public MetaMethod getStaticMetaMethod(String name, Class[] argTypes)

  - ### getProperty

    public Object getProperty(Class sender, Object object, String name, boolean useSuper, boolean fromInsideClass)
    Description copied from interface: `MetaClass`

    Retrieves a property on the given receiver for the specified arguments. The sender is the class that is requesting the property from the object. The MetaClass will attempt to establish the method to invoke based on the name and arguments provided.

    The isCallToSuper and fromInsideClass help the Groovy runtime perform optimisations on the call to go directly to the super class if necessary

    Specified by:
      `getProperty` in interface `MetaClass`
    Overrides:
      `getProperty` in class `MetaClassImpl`
    Parameters:
      `sender` - The java.lang.Class instance that requested the property
      `object` - The Object which the property is being retrieved from
      `name` - The name of the property
      `useSuper` - Whether the call is to a super class property
      `fromInsideClass` - ??
    Returns:
      the given property's value on the object

  - ### getAttribute

    public Object getAttribute(Class sender, Object object, String attribute, boolean useSuper, boolean fromInsideClass)
    Description copied from class: `MetaClassImpl`
    Retrieves the value of an attribute (field). This method is to support the Groovy runtime and not for general client API usage.
    Overrides:
      `getAttribute` in class `MetaClassImpl`
    Parameters:
      `sender` - The class of the object that requested the attribute
      `object` - The instance the attribute is to be retrieved from
      `attribute` - The name of the attribute
      `useSuper` - Whether to look-up on the super class or not
      `fromInsideClass` - Whether the call was invoked from the inside or the outside of the class.
    Returns:
      The attribute value

  - ### setAttribute

    public void setAttribute(Class sender, Object object, String attribute, Object newValue, boolean useSuper, boolean fromInsideClass)
    Description copied from class: `MetaClassImpl`

    Sets an attribute on the given receiver for the specified arguments. The sender is the class that is setting the attribute from the object. The MetaClass will attempt to establish the method to invoke based on the name and arguments provided.

    The isCallToSuper and fromInsideClass help the Groovy runtime perform optimisations on the call to go directly to the super class if necessary

    Specified by:
      `setAttribute` in interface `MetaClass`
    Overrides:
      `setAttribute` in class `MetaClassImpl`
    Parameters:
      `sender` - The java.lang.Class instance that is mutating the property
      `object` - The Object which the property is being set on
      `attribute` - The name of the attribute,
      `newValue` - The new value of the attribute to set
      `useSuper` - Whether the call is to a super class property
      `fromInsideClass` - Whether the call was invoked from the inside or the outside of the class

  - ### invokeStaticMethod

    public Object invokeStaticMethod(Object object, String methodName, Object[] arguments)
    Description copied from interface: `MetaObjectProtocol`
    Invokes a static method on the given Object with the given name and arguments.

    The Object can either be an instance of the class that this MetaObjectProtocol instance applies to or the java.lang.Class instance itself. If a method cannot be invoked a MissingMethodException is will be thrown

    Specified by:
      `invokeStaticMethod` in interface `MetaObjectProtocol`
    Overrides:
      `invokeStaticMethod` in class `MetaClassImpl`
    Parameters:
      `object` - An instance of the class returned by the getTheClass() method or the class itself
      `methodName` - The name of the method
      `arguments` - The arguments to the method
    Returns:
      The return value of the method which is null if the return type is void
    See Also:
      - `MissingMethodException`

  - ### setProperty

    public void setProperty(Class sender, Object object, String name, Object newValue, boolean useSuper, boolean fromInsideClass)
    Description copied from class: `MetaClassImpl`

    Retrieves a property on the given receiver for the specified arguments. The sender is the class that is requesting the property from the object. The MetaClass will attempt to establish the method to invoke based on the name and arguments provided.

    The useSuper and fromInsideClass help the Groovy runtime perform optimisations on the call to go directly to the super class if necessary

    Specified by:
      `setProperty` in interface `MetaClass`
    Overrides:
      `setProperty` in class `MetaClassImpl`
    Parameters:
      `sender` - The java.lang.Class instance that is mutating the property
      `object` - The Object which the property is being set on
      `name` - The name of the property
      `newValue` - The new value of the property to set
      `useSuper` - Whether the call is to a super class property
      `fromInsideClass` - Whether the call was invoked from the inside or the outside of the class.

  - ### getMethodWithoutCaching

    public MetaMethod getMethodWithoutCaching(int index, Class sender, String methodName, Class[] arguments, boolean isCallToSuper)

  - ### setProperties

    public void setProperties(Object bean, Map map)
    Description copied from class: `MetaClassImpl`
    Sets a number of bean properties from the given Map where the keys are the String names of properties and the values are the values of the properties to set
    Overrides:
      `setProperties` in class `MetaClassImpl`

  - ### addMetaBeanProperty

    public void addMetaBeanProperty(MetaBeanProperty mp)
    Description copied from class: `MetaClassImpl`
    Adds a new MetaBeanProperty to this MetaClass
    Specified by:
      `addMetaBeanProperty` in interface `MutableMetaClass`
    Overrides:
      `addMetaBeanProperty` in class `MetaClassImpl`
    Parameters:
      `mp` - The MetaBeanProperty

  - ### addMetaMethod

    public void addMetaMethod(MetaMethod method)
    Description copied from class: `MetaClassImpl`
    adds a MetaMethod to this class. WARNING: this method will not do the neccessary steps for multimethod logic and using this method doesn't mean, that a method added here is replacing another method from a parent class completely. These steps are usually done by initialize, which means if you need these steps, you have to add the method before running initialize the first time.
    Specified by:
      `addMetaMethod` in interface `MutableMetaClass`
    Overrides:
      `addMetaMethod` in class `MetaClassImpl`
    Parameters:
      `method` - the MetaMethod
    See Also:
      - `MetaClassImpl.initialize()`

  - ### addNewInstanceMethod

    public void addNewInstanceMethod(Method method)
    Description copied from class: `MetaClassImpl`
    Adds an instance method to this metaclass.
    Specified by:
      `addNewInstanceMethod` in interface `MutableMetaClass`
    Overrides:
      `addNewInstanceMethod` in class `MetaClassImpl`
    Parameters:
      `method` - The method to be added

  - ### addNewStaticMethod

    public void addNewStaticMethod(Method method)
    Description copied from class: `MetaClassImpl`
    Adds a static method to this metaclass.
    Specified by:
      `addNewStaticMethod` in interface `MutableMetaClass`
    Overrides:
      `addNewStaticMethod` in class `MetaClassImpl`
    Parameters:
      `method` - The method to be added

  - ### retrieveConstructor

    public Constructor retrieveConstructor(Class[] arguments)
    Overrides:
      `retrieveConstructor` in class `MetaClassImpl`

  - ### createPojoCallSite

    public CallSite createPojoCallSite(CallSite site, Object receiver, Object[] args)
    Description copied from class: `MetaClassImpl`
    Create a CallSite
    Overrides:
      `createPojoCallSite` in class `MetaClassImpl`

  - ### createPogoCallSite

    public CallSite createPogoCallSite(CallSite site, Object[] args)
    Description copied from class: `MetaClassImpl`
    Create a CallSite
    Overrides:
      `createPogoCallSite` in class `MetaClassImpl`

  - ### createPogoCallCurrentSite

    public CallSite createPogoCallCurrentSite(CallSite site, Class sender, Object[] args)
    Description copied from class: `MetaClassImpl`
    Create a CallSite
    Overrides:
      `createPogoCallCurrentSite` in class `MetaClassImpl`

  - ### respondsTo

    public List respondsTo(Object obj, String name, Object[] argTypes)
    Description copied from interface: `MetaObjectProtocol`

    Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name and arguments types.

    Note that this method's return value is based on realised methods and does not take into account objects or classes that implement invokeMethod or methodMissing

    This method is "safe" in that it will always return a value and never throw an exception

    Specified by:
      `respondsTo` in interface `MetaObjectProtocol`
    Overrides:
      `respondsTo` in class `MetaClassImpl`
    Parameters:
      `obj` - The object to inspect
      `name` - The name of the method of interest
      `argTypes` - The argument types to match against
    Returns:
      A List of MetaMethods matching the argument types which will be empty if no matching methods exist
    See Also:
      - `MetaObjectProtocol.respondsTo(Object, String, Object[])`

  - ### respondsTo

    public List respondsTo(Object obj, String name)
    Description copied from interface: `MetaObjectProtocol`

    Returns an object satisfying Groovy truth if the implementing MetaClass responds to a method with the given name regardless of arguments. In other words this method will return for foo() and foo(String).

    Note that this method's return value is based on realised methods and does not take into account objects or classes that implement invokeMethod or methodMissing

    This method is "safe" in that it will always return a value and never throw an exception

    Specified by:
      `respondsTo` in interface `MetaObjectProtocol`
    Overrides:
      `respondsTo` in class `MetaClassImpl`
    Parameters:
      `obj` - The object to inspect
      `name` - The name of the method of interest
    Returns:
      A List of MetaMethods which will be empty if no methods with the given name exist
    See Also:
      - `MetaObjectProtocol.respondsTo(Object, String)`

  - ### applyPropertyDescriptors

    protected void applyPropertyDescriptors(PropertyDescriptor[] propertyDescriptors)
    Overrides:
      `applyPropertyDescriptors` in class `MetaClassImpl`