Package org.codehaus.groovy.runtime.metaclass

# Class OwnedMetaClass

java.lang.Object
groovy.lang.DelegatingMetaClass
org.codehaus.groovy.runtime.metaclass.OwnedMetaClass

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

Direct Known Subclasses:
  `MixedInMetaClass`

public abstract class OwnedMetaClass extends DelegatingMetaClass

- ## Field Summary

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

  `delegate`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `OwnedMetaClass(MetaClass delegate)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `equals(Object obj)`
  `Object`
  `getAttribute(Class sender, Object receiver, String messageName, boolean useSuper)`
  Retrieves the value of an attribute (field).
  `Object`
  `getAttribute(Object object, String attribute)`
  Retrieves an attribute of an instance of the class returned by the getTheClass() method.
  `ClassNode`
  `getClassNode()`
  Obtains a reference to the original AST for the MetaClass if it is available at runtime
  `MetaMethod`
  `getMetaMethod(String name, Class[] argTypes)`
  `MetaMethod`
  `getMetaMethod(String name, Object[] args)`
  Retrieves an instance MetaMethod for the given name and argument values, using the types of the argument values to establish the chosen MetaMethod
  `List<MetaMethod>`
  `getMetaMethods()`
  Retrieves a 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 a list of MetaMethods held by the class.
  `protected abstract Object`
  `getOwner()`
  `protected abstract MetaClass`
  `getOwnerMetaClass(Object owner)`
  `List<MetaProperty>`
  `getProperties()`
  Retrieves a list of MetaProperty instances that the MetaClass has
  `Object`
  `getProperty(Class sender, Object receiver, String messageName, boolean useSuper, boolean fromInsideClass)`
  Retrieves a property on the given receiver for the specified arguments.
  `Object`
  `getProperty(Object object, String property)`
  Retrieves a property of an instance of the class returned by the getTheClass() method.
  `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
  `Class`
  `getTheClass()`
  Retrieves that Java Class that the attached Meta behaviours apply to
  `int`
  `hashCode()`
  `MetaProperty`
  `hasProperty(Object obj, String name)`
  Returns true of the implementing MetaClass has a property of the given name
  `Object`
  `invokeConstructor(Object[] arguments)`
  Invokes a constructor for the given arguments.
  `Object`
  `invokeMethod(Class sender, Object receiver, String methodName, Object[] arguments, boolean isCallToSuper, boolean fromInsideClass)`
  Invokes a method on the given receiver for the specified arguments.
  `Object`
  `invokeMethod(Object object, String methodName, Object arguments)`
  Invokes a method on the given object, with the given name and single argument.
  `Object`
  `invokeMethod(Object object, String methodName, Object[] arguments)`
  Invokes a method on the given Object with the given name and arguments.
  `Object`
  `invokeMissingMethod(Object instance, String methodName, Object[] arguments)`
  Attempts to invoke the methodMissing method otherwise throws a MissingMethodException
  `Object`
  `invokeMissingProperty(Object instance, String propertyName, Object optionalValue, boolean isGetter)`
  Invokes the propertyMissing method otherwise throws a MissingPropertyException
  `Object`
  `invokeStaticMethod(Object object, String methodName, Object[] arguments)`
  Invokes a static method on the given Object with the given name and arguments.
  `boolean`
  `isGroovyObject()`
  `List<MetaMethod>`
  `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<MetaMethod>`
  `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.
  `int`
  `selectConstructorAndTransformArguments(int numberOfConstructors, Object[] arguments)`
  Internal method to support Groovy runtime.
  `void`
  `setAttribute(Class sender, Object receiver, String messageName, Object messageValue, boolean useSuper, boolean fromInsideClass)`
  Sets the value of an attribute (field).
  `void`
  `setAttribute(Object object, String attribute, Object newValue)`
  Sets an attribute of an instance of the class returned by the getTheClass() method.
  `void`
  `setProperty(Class sender, Object receiver, String messageName, Object messageValue, boolean useSuper, boolean fromInsideClass)`
  Sets a property on the given receiver for the specified arguments.
  `void`
  `setProperty(Object object, String property, Object newValue)`
  Sets a property of an instance of the class returned by the getTheClass() method.
  `String`
  `toString()`

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

  `addMetaBeanProperty, addMetaMethod, addNewInstanceMethod, addNewStaticMethod, getAdaptee, getMetaClass, getProperty, initialize, invokeMethod, isModified, pickMethod, setAdaptee, setMetaClass, setProperty`

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

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

- ## Constructor Details

  - ### OwnedMetaClass

    public OwnedMetaClass(MetaClass delegate)

- ## Method Details

  - ### getAttribute

    public Object getAttribute(Object object, String attribute)
    Description copied from interface: `MetaObjectProtocol`
    Retrieves an attribute of an instance of the class returned by the getTheClass() method.

    What this means is largely down to the MetaClass implementation, however the default case would result in attempt to read a field of the instance.

    Specified by:
      `getAttribute` in interface `MetaObjectProtocol`
    Overrides:
      `getAttribute` in class `DelegatingMetaClass`
    Parameters:
      `object` - An instance of the class returned by the getTheClass() method
      `attribute` - The name of the attribute to retrieve the value for
    Returns:
      The attribute value
    See Also:
      - `MetaClassImpl`

  - ### getOwner

    protected abstract Object getOwner()

  - ### getClassNode

    public ClassNode getClassNode()
    Description copied from interface: `MetaClass`
    Obtains a reference to the original AST for the MetaClass if it is available at runtime
    Specified by:
      `getClassNode` in interface `MetaClass`
    Overrides:
      `getClassNode` in class `DelegatingMetaClass`
    Returns:
      The original AST or null if it cannot be returned

  - ### getMetaMethods

    public List<MetaMethod> getMetaMethods()
    Description copied from interface: `MetaClass`
    Retrieves a 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 `DelegatingMetaClass`
    Returns:
      A list of MetaMethods

  - ### getMethods

    public List<MetaMethod> getMethods()
    Description copied from interface: `MetaClass`
    Retrieves a 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 `DelegatingMetaClass`
    Returns:
      A list of MetaMethods
    See Also:
      - `MetaMethod`

  - ### respondsTo

    public List<MetaMethod> 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 `DelegatingMetaClass`
    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

  - ### respondsTo

    public List<MetaMethod> 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 `DelegatingMetaClass`
    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

  - ### hasProperty

    public MetaProperty hasProperty(Object obj, String name)
    Description copied from interface: `MetaObjectProtocol`

    Returns true of the implementing MetaClass has a property of the given name

    Note that this method will only return true for realised properties and does not take into account implementation of getProperty or propertyMissing

    Specified by:
      `hasProperty` in interface `MetaObjectProtocol`
    Overrides:
      `hasProperty` in class `DelegatingMetaClass`
    Parameters:
      `obj` - The object to inspect
      `name` - The name of the property
    Returns:
      The MetaProperty or null if it doesn't exist

  - ### getProperties

    public List<MetaProperty> getProperties()
    Description copied from interface: `MetaClass`
    Retrieves a list of MetaProperty instances that the MetaClass has
    Specified by:
      `getProperties` in interface `MetaClass`
    Specified by:
      `getProperties` in interface `MetaObjectProtocol`
    Overrides:
      `getProperties` in class `DelegatingMetaClass`
    Returns:
      A list of MetaProperty instances
    See Also:
      - `MetaProperty`

  - ### getProperty

    public Object getProperty(Object object, String property)
    Description copied from interface: `MetaObjectProtocol`
    Retrieves a property of an instance of the class returned by the getTheClass() method.

    What this means is largely down to the MetaClass implementation, however the default case would result in an attempt to invoke a JavaBean getter, or if no such getter exists a public field of the instance.

    Specified by:
      `getProperty` in interface `MetaObjectProtocol`
    Overrides:
      `getProperty` in class `DelegatingMetaClass`
    Parameters:
      `object` - An instance of the class returned by the getTheClass() method
      `property` - The name of the property to retrieve the value for
    Returns:
      The properties value
    See Also:
      - `MetaClassImpl`

  - ### invokeConstructor

    public Object invokeConstructor(Object[] arguments)
    Description copied from interface: `MetaObjectProtocol`
    Invokes a constructor for the given arguments. The MetaClass will attempt to pick the best argument which matches the types of the objects passed within the arguments array
    Specified by:
      `invokeConstructor` in interface `MetaObjectProtocol`
    Overrides:
      `invokeConstructor` in class `DelegatingMetaClass`
    Parameters:
      `arguments` - The arguments to the constructor
    Returns:
      An instance of the java.lang.Class that this MetaObjectProtocol object applies to

  - ### invokeMethod

    public Object invokeMethod(Object object, String methodName, Object arguments)
    Description copied from interface: `MetaObjectProtocol`
    Invokes a method on the given object, with the given name and single argument.
    Specified by:
      `invokeMethod` in interface `MetaObjectProtocol`
    Overrides:
      `invokeMethod` in class `DelegatingMetaClass`
    Parameters:
      `object` - The Object to invoke the method on
      `methodName` - The name of the method
      `arguments` - The argument to the method
    Returns:
      The return value of the method which is null if the return type is void
    See Also:
      - `MetaObjectProtocol.invokeMethod(Object, String, Object[])`

  - ### invokeMethod

    public Object invokeMethod(Object object, String methodName, Object[] arguments)
    Description copied from interface: `MetaObjectProtocol`
    Invokes a method on the given Object with the given name and arguments. The MetaClass will attempt to pick the best method for the given name and arguments. If a method cannot be invoked a MissingMethodException will be thrown.
    Specified by:
      `invokeMethod` in interface `MetaObjectProtocol`
    Overrides:
      `invokeMethod` in class `DelegatingMetaClass`
    Parameters:
      `object` - The instance which the method is invoked on
      `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`

  - ### getOwnerMetaClass

    protected abstract MetaClass getOwnerMetaClass(Object owner)

  - ### 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 `DelegatingMetaClass`
    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`

  - ### setAttribute

    public void setAttribute(Object object, String attribute, Object newValue)
    Description copied from interface: `MetaObjectProtocol`
    Sets an attribute of an instance of the class returned by the getTheClass() method.

    What this means is largely down to the MetaClass implementation, however the default case would result in an attempt to set a field of the instance.

    Specified by:
      `setAttribute` in interface `MetaObjectProtocol`
    Overrides:
      `setAttribute` in class `DelegatingMetaClass`
    Parameters:
      `object` - An instance of the class returned by the getTheClass() method
      `attribute` - The name of the attribute to set
      `newValue` - The new value of the attribute
    See Also:
      - `MetaClassImpl`

  - ### setProperty

    public void setProperty(Object object, String property, Object newValue)
    Description copied from interface: `MetaObjectProtocol`
    Sets a property of an instance of the class returned by the getTheClass() method.

    What this means is largely down to the MetaClass implementation, however the default case would result in an attempt to invoke a JavaBean setter, or if no such setter exists to set a public field of the instance.

    Specified by:
      `setProperty` in interface `MetaObjectProtocol`
    Overrides:
      `setProperty` in class `DelegatingMetaClass`
    Parameters:
      `object` - An instance of the class returned by the getTheClass() method
      `property` - The name of the property to set
      `newValue` - The new value of the property
    See Also:
      - `MetaClassImpl`

  - ### equals

    public boolean equals(Object obj)
    Overrides:
      `equals` in class `DelegatingMetaClass`

  - ### hashCode

    public int hashCode()
    Overrides:
      `hashCode` in class `DelegatingMetaClass`

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `DelegatingMetaClass`

  - ### getAttribute

    public Object getAttribute(Class sender, Object receiver, String messageName, boolean useSuper)
    Description copied from interface: `MetaClass`
    Retrieves the value of an attribute (field). This method is to support the Groovy runtime and not for general client API usage.
    Specified by:
      `getAttribute` in interface `MetaClass`
    Overrides:
      `getAttribute` in class `DelegatingMetaClass`
    Parameters:
      `sender` - The class of the object that requested the attribute
      `receiver` - The instance
      `messageName` - The name of the attribute
      `useSuper` - Whether to look-up on the super class or not
    Returns:
      The attribute value

  - ### getProperty

    public Object getProperty(Class sender, Object receiver, String messageName, 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 `DelegatingMetaClass`
    Parameters:
      `sender` - The java.lang.Class instance that requested the property
      `receiver` - The Object which the property is being retrieved from
      `messageName` - The name of the property
      `useSuper` - Whether the call is to a super class property
      `fromInsideClass` - ??
    Returns:
      The properties value

  - ### 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 `DelegatingMetaClass`
    Parameters:
      `name` - The name of the MetaProperty
    Returns:
      A MetaProperty or null

  - ### 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 `DelegatingMetaClass`
    Parameters:
      `name` - The name of the MetaMethod
      `args` - The argument types
    Returns:
      A MetaMethod or null if it doesn't exist

  - ### getStaticMetaMethod

    public MetaMethod getStaticMetaMethod(String name, Class[] argTypes)
    Overrides:
      `getStaticMetaMethod` in class `DelegatingMetaClass`

  - ### getMetaMethod

    public MetaMethod getMetaMethod(String name, Object[] args)
    Description copied from interface: `MetaObjectProtocol`
    Retrieves an instance MetaMethod for the given name and argument values, using the types of the argument values to establish the chosen MetaMethod
    Specified by:
      `getMetaMethod` in interface `MetaObjectProtocol`
    Overrides:
      `getMetaMethod` in class `DelegatingMetaClass`
    Parameters:
      `name` - The name of the MetaMethod
      `args` - Array containing - 1) the argument values (using which their types are then inferred), or 2) the corresponding argument types
    Returns:
      A MetaMethod or null if it doesn't exist

  - ### getMetaMethod

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

  - ### getTheClass

    public Class getTheClass()
    Description copied from interface: `MetaObjectProtocol`
    Retrieves that Java Class that the attached Meta behaviours apply to
    Specified by:
      `getTheClass` in interface `MetaObjectProtocol`
    Overrides:
      `getTheClass` in class `DelegatingMetaClass`
    Returns:
      The java.lang.Class instance

  - ### invokeMethod

    public Object invokeMethod(Class sender, Object receiver, String methodName, Object[] arguments, boolean isCallToSuper, boolean fromInsideClass)
    Description copied from interface: `MetaClass`

    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 `DelegatingMetaClass`
    Parameters:
      `sender` - The java.lang.Class instance that invoked the method
      `receiver` - The object which the method was invoked on
      `methodName` - The name of the method
      `arguments` - 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

  - ### invokeMissingMethod

    public Object invokeMissingMethod(Object instance, String methodName, Object[] arguments)
    Description copied from interface: `MetaClass`

    Attempts to invoke the methodMissing method otherwise throws a MissingMethodException

    Specified by:
      `invokeMissingMethod` in interface `MetaClass`
    Overrides:
      `invokeMissingMethod` in class `DelegatingMetaClass`
    Parameters:
      `instance` - The instance to invoke methodMissing on
      `methodName` - The name of the method
      `arguments` - The arguments to the method
    Returns:
      The results of methodMissing or throws MissingMethodException
    See Also:
      - `MissingMethodException`

  - ### invokeMissingProperty

    public Object invokeMissingProperty(Object instance, String propertyName, Object optionalValue, boolean isGetter)
    Description copied from interface: `MetaClass`
    Invokes the propertyMissing method otherwise throws a MissingPropertyException
    Specified by:
      `invokeMissingProperty` in interface `MetaClass`
    Overrides:
      `invokeMissingProperty` in class `DelegatingMetaClass`
    Parameters:
      `instance` - The instance of the class
      `propertyName` - The name of the property
      `optionalValue` - The value of the property which could be null in the case of a getter
      `isGetter` - Whether the missing property event was the result of a getter or a setter
    Returns:
      The result of the propertyMissing method or throws MissingPropertyException

  - ### isGroovyObject

    public boolean isGroovyObject()
    Overrides:
      `isGroovyObject` in class `DelegatingMetaClass`

  - ### setAttribute

    public void setAttribute(Class sender, Object receiver, String messageName, Object messageValue, boolean useSuper, boolean fromInsideClass)
    Description copied from interface: `MetaClass`
    Sets the value of an attribute (field). This method is to support the Groovy runtime and not for general client API usage.
    Specified by:
      `setAttribute` in interface `MetaClass`
    Overrides:
      `setAttribute` in class `DelegatingMetaClass`
    Parameters:
      `sender` - The class of the object that requested the attribute
      `receiver` - The instance
      `messageName` - The name of the attribute
      `messageValue` - The value of the attribute
      `useSuper` - Whether to look-up on the super class or not
      `fromInsideClass` - Whether the call happened from the inside or the outside of a class

  - ### setProperty

    public void setProperty(Class sender, Object receiver, String messageName, Object messageValue, boolean useSuper, boolean fromInsideClass)
    Description copied from interface: `MetaClass`

    Sets a property on the given receiver for the specified arguments. The sender is the class that is setting 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:
      `setProperty` in interface `MetaClass`
    Overrides:
      `setProperty` in class `DelegatingMetaClass`
    Parameters:
      `sender` - The java.lang.Class instance that is mutating the property
      `receiver` - The Object which the property is being set on
      `messageName` - The name of the property
      `messageValue` - 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

  - ### selectConstructorAndTransformArguments

    public int selectConstructorAndTransformArguments(int numberOfConstructors, Object[] arguments)
    Description copied from interface: `MetaClass`
    Internal method to support Groovy runtime. Not for client usage.
    Specified by:
      `selectConstructorAndTransformArguments` in interface `MetaClass`
    Overrides:
      `selectConstructorAndTransformArguments` in class `DelegatingMetaClass`
    Parameters:
      `numberOfConstructors` - The number of constructors
      `arguments` - The arguments
    Returns:
      selected index