Package groovy.lang

Class MetaClassImpl

    • Field Detail

      • STATIC_METHOD_MISSING

        protected static final java.lang.String STATIC_METHOD_MISSING
        See Also:
        Constant Field Values

      • STATIC_PROPERTY_MISSING

        protected static final java.lang.String STATIC_PROPERTY_MISSING
        See Also:
        Constant Field Values

      • PROPERTY_MISSING

        protected static final java.lang.String PROPERTY_MISSING
        See Also:
        Constant Field Values

      • INVOKE_METHOD_METHOD

        protected static final java.lang.String INVOKE_METHOD_METHOD
        See Also:
        Constant Field Values

      • theClass

        protected final java.lang.Class theClass

      • theCachedClass

        protected final CachedClass theCachedClass

      • getPropertyMethod

        protected MetaMethod getPropertyMethod

      • invokeMethodMethod

        protected MetaMethod invokeMethodMethod

      • setPropertyMethod

        protected MetaMethod setPropertyMethod

      • isGroovyObject

        protected final boolean isGroovyObject

      • isMap

        protected final boolean isMap

    • Constructor Detail

      • MetaClassImpl

        public MetaClassImpl​(java.lang.Class theClass,
                     MetaMethod[] add)

      • MetaClassImpl

        public MetaClassImpl​(java.lang.Class theClass)

      • MetaClassImpl

        public MetaClassImpl​(MetaClassRegistry registry,
                     java.lang.Class theClass)

    • Method Detail

      • getTheCachedClass

        public final CachedClass getTheCachedClass()

      • respondsTo

        public java.util.List respondsTo​(java.lang.Object obj,
                                 java.lang.String name,
                                 java.lang.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
        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 java.util.List respondsTo​(java.lang.Object obj,
                                 java.lang.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
        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)

      • hasProperty

        public MetaProperty hasProperty​(java.lang.Object obj,
                                java.lang.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
        Parameters:
        obj - The object to inspect
        name - The name of the property
        Returns:
        The MetaProperty or null if it doesn't exist
        See Also:
        MetaObjectProtocol.hasProperty(Object,String)

      • getMetaMethod

        public MetaMethod getMetaMethod​(java.lang.String name,
                                java.lang.Object[] argTypes)
        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
        Parameters:
        name - The name of the MetaMethod
        argTypes - 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
        See Also:
        MetaObjectProtocol.getMetaMethod(String, Object[])

      • getTheClass

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

      • isGroovyObject

        public boolean isGroovyObject()

      • getSuperClasses

        protected java.util.LinkedList<CachedClass> getSuperClasses()

      • isModified

        public boolean isModified()
        Description copied from interface: MutableMetaClass
        Return whether the MetaClass has been modified or not
        Specified by:
        isModified in interface MutableMetaClass
        Returns:
        True if it has

      • addNewInstanceMethod

        public void addNewInstanceMethod​(java.lang.reflect.Method method)
        Description copied from interface: MutableMetaClass
        adds a new instance method to this MetaClass. Instance methods are able to overwrite the original methods of the class. Calling this method should not be done after initialise was called.
        Specified by:
        addNewInstanceMethod in interface MutableMetaClass
        Parameters:
        method - the method to be added

      • addNewStaticMethod

        public void addNewStaticMethod​(java.lang.reflect.Method method)
        Description copied from interface: MutableMetaClass
        adds a new static method to this MetaClass. This is only possible as long as initialise was not called.
        Specified by:
        addNewStaticMethod in interface MutableMetaClass
        Parameters:
        method - the method to be added

      • invokeMethod

        public java.lang.Object invokeMethod​(java.lang.Object object,
                                     java.lang.String methodName,
                                     java.lang.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
        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[])

      • invokeMissingMethod

        public java.lang.Object invokeMissingMethod​(java.lang.Object instance,
                                            java.lang.String methodName,
                                            java.lang.Object[] arguments)
        Description copied from interface: MetaClass

        Attempts to invoke the methodMissing method otherwise throws a MissingMethodException

        Specified by:
        invokeMissingMethod in interface MetaClass
        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 java.lang.Object invokeMissingProperty​(java.lang.Object instance,
                                              java.lang.String propertyName,
                                              java.lang.Object optionalValue,
                                              boolean isGetter)
        Description copied from interface: MetaClass
        Invokes the propertyMissing method otherwise throws a MissingPropertyException
        Specified by:
        invokeMissingProperty in interface MetaClass
        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

      • onSuperPropertyFoundInHierarchy

        protected void onSuperPropertyFoundInHierarchy​(MetaBeanProperty property)

      • onMixinMethodFound

        protected void onMixinMethodFound​(MetaMethod method)

      • onSuperMethodFoundInHierarchy

        protected void onSuperMethodFoundInHierarchy​(MetaMethod method)

      • onInvokeMethodFoundInHierarchy

        protected void onInvokeMethodFoundInHierarchy​(MetaMethod method)

      • onSetPropertyFoundInHierarchy

        protected void onSetPropertyFoundInHierarchy​(MetaMethod method)

      • onGetPropertyFoundInHierarchy

        protected void onGetPropertyFoundInHierarchy​(MetaMethod method)

      • invokeStaticMissingProperty

        protected java.lang.Object invokeStaticMissingProperty​(java.lang.Object instance,
                                                       java.lang.String propertyName,
                                                       java.lang.Object optionalValue,
                                                       boolean isGetter)
        Hook to deal with the case of MissingProperty for static properties. The method will look attempt to look up "propertyMissing" handlers and invoke them otherwise thrown a MissingPropertyException
        Parameters:
        instance - The instance
        propertyName - The name of the property
        optionalValue - The value in the case of a setter
        isGetter - True if its a getter
        Returns:
        The value in the case of a getter or a MissingPropertyException

      • invokeMethod

        public java.lang.Object invokeMethod​(java.lang.Object object,
                                     java.lang.String methodName,
                                     java.lang.Object[] originalArguments)
        Invokes the given method on the object. TODO: should this be deprecated? If so, we have to propogate to many places.
        Specified by:
        invokeMethod in interface MetaObjectProtocol
        Parameters:
        object - The instance which the method is invoked on
        methodName - The name of the method
        originalArguments - The arguments to the method
        Returns:
        The return value of the method which is null if the return type is void
        See Also:
        MissingMethodException

      • invokeMethod

        public java.lang.Object invokeMethod​(java.lang.Class sender,
                                     java.lang.Object object,
                                     java.lang.String methodName,
                                     java.lang.Object[] originalArguments,
                                     boolean isCallToSuper,
                                     boolean fromInsideClass)
        Invokes the given method on the object.
        Specified by:
        invokeMethod in interface MetaClass
        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

      • getMethodWithCaching

        public MetaMethod getMethodWithCaching​(java.lang.Class sender,
                                       java.lang.String methodName,
                                       java.lang.Object[] arguments,
                                       boolean isCallToSuper)

      • retrieveConstructor

        public java.lang.reflect.Constructor retrieveConstructor​(java.lang.Class[] arguments)

      • retrieveStaticMethod

        public MetaMethod retrieveStaticMethod​(java.lang.String methodName,
                                       java.lang.Object[] arguments)

      • getMethodWithoutCaching

        public MetaMethod getMethodWithoutCaching​(java.lang.Class sender,
                                          java.lang.String methodName,
                                          java.lang.Class[] arguments,
                                          boolean isCallToSuper)

      • invokeStaticMethod

        public java.lang.Object invokeStaticMethod​(java.lang.Object object,
                                           java.lang.String methodName,
                                           java.lang.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
        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

      • invokeConstructorAt

        public java.lang.Object invokeConstructorAt​(java.lang.Class at,
                                            java.lang.Object[] arguments)
        Deprecated.
        use invokeConstructor instead
        Warning, this method will be removed

      • invokeConstructor

        public java.lang.Object invokeConstructor​(java.lang.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
        Parameters:
        arguments - The arguments to the constructor
        Returns:
        An instance of the java.lang.Class that this MetaObjectProtocol object applies to

      • selectConstructorAndTransformArguments

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

      • checkInitalised

        protected void checkInitalised()
        checks if the initialisation of the class id complete. This method should be called as a form of assert, it is no way to test if there is still initialisation work to be done. Such logic must be implemented in a different way.
        Throws:
        java.lang.IllegalStateException - if the initialisation is incomplete yet

      • setProperties

        public void setProperties​(java.lang.Object bean,
                          java.util.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

      • getProperty

        public java.lang.Object getProperty​(java.lang.Class sender,
                                    java.lang.Object object,
                                    java.lang.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
        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

      • getEffectiveGetMetaProperty

        public MetaProperty getEffectiveGetMetaProperty​(java.lang.Class sender,
                                                java.lang.Object object,
                                                java.lang.String name,
                                                boolean useSuper)

      • applyPropertyDescriptors

        protected void applyPropertyDescriptors​(java.beans.PropertyDescriptor[] propertyDescriptors)

      • setProperty

        public void setProperty​(java.lang.Class sender,
                        java.lang.Object object,
                        java.lang.String name,
                        java.lang.Object newValue,
                        boolean useSuper,
                        boolean fromInsideClass)
        Sets the property value on an object
        Specified by:
        setProperty in interface MetaClass
        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 - ??

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.Class sender,
                                     java.lang.Object receiver,
                                     java.lang.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
        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

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.Class sender,
                                     java.lang.Object object,
                                     java.lang.String attribute,
                                     boolean useSuper,
                                     boolean fromInsideClass)
        Looks up the given attribute (field) on the given object

      • setAttribute

        public void setAttribute​(java.lang.Class sender,
                         java.lang.Object object,
                         java.lang.String attribute,
                         java.lang.Object newValue,
                         boolean useSuper,
                         boolean fromInsideClass)
        Sets the given attribute (field) on the given object
        Specified by:
        setAttribute in interface MetaClass
        Parameters:
        sender - The class of the object that requested the attribute
        object - The instance
        attribute - The name of the attribute
        newValue - 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

      • 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
        Returns:
        The original AST or null if it cannot be returned

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • addMetaMethod

        public void addMetaMethod​(MetaMethod method)
        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
        Parameters:
        method - the MetaMethod
        See Also:
        initialize()

      • checkIfGroovyObjectMethod

        protected final void checkIfGroovyObjectMethod​(MetaMethod metaMethod)
        Checks if the metaMethod is a method from the GroovyObject interface such as setProperty, getProperty and invokeMethod
        Parameters:
        metaMethod - The metaMethod instance
        See Also:
        GroovyObject

      • isInitialized

        protected boolean isInitialized()

      • chooseMethod

        protected java.lang.Object chooseMethod​(java.lang.String methodName,
                                        java.lang.Object methodOrList,
                                        java.lang.Class[] arguments)
        Chooses the correct method to use from a list of methods which match by name.
        Parameters:
        methodOrList - the possible methods to choose from
        arguments -

      • initialize

        public void initialize()
        Description copied from interface: MetaClass
        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

      • getMetaMethods

        public java.util.List<MetaMethod> getMetaMethods()
        Description copied from interface: MetaClass
        Retrieves a list of MetaMethods held by this class
        Specified by:
        getMetaMethods in interface MetaClass
        Returns:
        A list of MetaMethods

      • dropStaticMethodCache

        protected void dropStaticMethodCache​(java.lang.String name)

      • dropMethodCache

        protected void dropMethodCache​(java.lang.String name)

      • createPojoCallSite

        public CallSite createPojoCallSite​(CallSite site,
                                   java.lang.Object receiver,
                                   java.lang.Object[] args)

      • createStaticSite

        public CallSite createStaticSite​(CallSite site,
                                 java.lang.Object[] args)

      • createPogoCallSite

        public CallSite createPogoCallSite​(CallSite site,
                                   java.lang.Object[] args)

      • createPogoCallCurrentSite

        public CallSite createPogoCallCurrentSite​(CallSite site,
                                          java.lang.Class sender,
                                          java.lang.Object[] args)

      • createConstructorSite

        public CallSite createConstructorSite​(CallSite site,
                                      java.lang.Object[] args)

      • getClassInfo

        public ClassInfo getClassInfo()

      • getVersion

        public int getVersion()

      • incVersion

        public void incVersion()

      • getAdditionalMetaMethods

        public MetaMethod[] getAdditionalMetaMethods()

      • findPropertyInClassHierarchy

        protected MetaBeanProperty findPropertyInClassHierarchy​(java.lang.String propertyName,
                                                        CachedClass theClass)

      • findMixinMethod

        protected MetaMethod findMixinMethod​(java.lang.String methodName,
                                     java.lang.Class[] arguments)

      • findMethodInClassHierarchy

        protected static MetaMethod findMethodInClassHierarchy​(java.lang.Class instanceKlazz,
                                                       java.lang.String methodName,
                                                       java.lang.Class[] arguments,
                                                       MetaClass metaClass)

      • findOwnMethod

        protected static MetaMethod findOwnMethod​(java.lang.Class instanceKlazz,
                                          java.lang.String methodName,
                                          java.lang.Class[] arguments,
                                          MetaClass metaClass,
                                          MetaMethod method)

      • getSubclassMetaMethods

        protected java.lang.Object getSubclassMetaMethods​(java.lang.String methodName)

      • getProperty

        public java.lang.Object getProperty​(java.lang.Object object,
                                    java.lang.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
        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

      • setProperty

        public void setProperty​(java.lang.Object object,
                        java.lang.String property,
                        java.lang.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
        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

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.Object object,
                                     java.lang.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
        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

      • setAttribute

        public void setAttribute​(java.lang.Object object,
                         java.lang.String attribute,
                         java.lang.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
        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

      • pickMethod

        public MetaMethod pickMethod​(java.lang.String methodName,
                             java.lang.Class[] arguments)
        Description copied from interface: MetaClass
        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
        Parameters:
        methodName - the name of the method to pick
        arguments - the method arguments
        Returns:
        a matching MetaMethod or null

      • retrieveMethod

        protected MetaMethod retrieveMethod​(java.lang.String methodName,
                                    java.lang.Class[] arguments)
        Deprecated.
        use pickMethod instead

      • clearInvocationCaches

        protected void clearInvocationCaches()
        remove all method call cache entries. This should be done if a method is added during runtime, but not by using a category.