Apache Groovy 3.0.20 · org.codehaus.groovy.vmplugin.VMPlugin

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: the result of checking checkAccessible(Class<?> callerClass the callerClass to invoke `setAccessible` callerClass, Class<?> the type of member owner declaringClass, int modifiers of member memberModifiers, boolean whether to allow illegal access allowIllegalAccess) check whether the member can be accessed or not
public boolean	Returns: the check result checkCanSetAccessible(AccessibleObject the accessible object to check accessibleObject, Class<?> the callerClass to invoke `setAccessible` callerClass) Check whether invoking `AccessibleObject#setAccessible(boolean)` on the accessible object will be completed successfully
public void	configureAnnotation(AnnotationNode an)
public void	configureAnnotationNodeFromDefinition(AnnotationNode definition, AnnotationNode root)
public void	configureClassNode(CompileUnit compileUnit, ClassNode classNode)
public default Map<String, Set<String>>	Returns: the default import classes getDefaultImportClasses(String[] the default import package names, e.g. java.lang. packageNames) Returns the default import classes: class name -> the relevant package names
public Object	Returns: null in case of jdk<7, otherwise a handle that takes the method call arguments for the invokespecial call getInvokeSpecialHandle(Method m, Object receiver) Returns a handle with bound receiver to invokeSpecial the given method.
public Class<T>[]	getPluginDefaultGroovyMethods()
public Class<T>[]	getPluginStaticGroovyMethods()
public int	Returns: 7 for jdk7, 8 for jdk8, 9 for jdk9 or higher getVersion() Gives the version the plugin is made for
public void	invalidateCallSites()
public Object	Returns: the result of the method call invokeHandle(Object the handle handle, Object[] arguments for the method call, can be empty but not null args) Invokes a handle produced by #getInvokeSpecialdHandle
public void	setAdditionalClassInformation(ClassNode c)
public MetaMethod	Returns: the transformed meta method transformMetaMethod(MetaClass meta class metaClass, MetaMethod the original meta method metaMethod, Class<?> caller class, whose method sets accessible for methods caller) transform meta method
public MetaMethod	Returns: the transformed meta method transformMetaMethod(MetaClass meta class metaClass, MetaMethod the original meta method metaMethod) transform meta method.
public boolean	Returns: `true` if the `accessible` flag is set to `true`; `false` if access cannot be enabled. trySetAccessible(AccessibleObject the accessible object ao) Set the `accessible` flag for this reflected object to `true` if possible.

Method Detail

checkAccessible back to summary

checkAccessible	back to summary
public boolean checkAccessible(Class<?> callerClass, Class<?> declaringClass, int memberModifiers, boolean allowIllegalAccess) check whether the member can be accessed or not Parameters callerClass:Class<?> callerClass the callerClass to invoke `setAccessible` declaringClass:Class<?> the type of member owner memberModifiers:int modifiers of member allowIllegalAccess:boolean whether to allow illegal access Returns:boolean the result of checking

public boolean checkAccessible(Class<?> callerClass, Class<?> declaringClass, int memberModifiers, boolean allowIllegalAccess)

check whether the member can be accessed or not

Parameters

callerClass:Class<?>: callerClass the callerClass to invoke setAccessible
declaringClass:Class<?>: the type of member owner
memberModifiers:int: modifiers of member
allowIllegalAccess:boolean: whether to allow illegal access

Returns:boolean

the result of checking

checkCanSetAccessible back to summary

checkCanSetAccessible	back to summary
public boolean checkCanSetAccessible(AccessibleObject accessibleObject, Class<?> callerClass) Check whether invoking `AccessibleObject#setAccessible(boolean)` on the accessible object will be completed successfully Parameters accessibleObject:AccessibleObject the accessible object to check callerClass:Class<?> the callerClass to invoke `setAccessible` Returns:boolean the check result

public boolean checkCanSetAccessible(AccessibleObject accessibleObject, Class<?> callerClass)

Check whether invoking AccessibleObject#setAccessible(boolean) on the accessible object will be completed successfully

Parameters

accessibleObject:AccessibleObject: the accessible object to check
callerClass:Class<?>: the callerClass to invoke setAccessible

Returns:boolean

the check result

configureAnnotation	back to summary
public void configureAnnotation(AnnotationNode an)

configureAnnotationNodeFromDefinition	back to summary
public void configureAnnotationNodeFromDefinition(AnnotationNode definition, AnnotationNode root)

configureClassNode	back to summary
public void configureClassNode(CompileUnit compileUnit, ClassNode classNode)

getDefaultImportClasses	back to summary
public default Map<String, Set<String>> getDefaultImportClasses(String[] packageNames) Returns the default import classes: class name -> the relevant package names Parameters packageNames:String[] the default import package names, e.g. java.lang. Returns:Map<String, Set<String>> the default import classes Since 3.0.2

getDefaultImportClasses

back to summary

public default Map<String, Set<String>> getDefaultImportClasses(String[] packageNames)

Returns the default import classes: class name -> the relevant package names

Parameters

packageNames:String[]: the default import package names, e.g. java.lang.

Returns:Map<String, Set<String>>

the default import classes

Since

3.0.2

getInvokeSpecialHandle	back to summary
public Object getInvokeSpecialHandle(Method m, Object receiver) Returns a handle with bound receiver to invokeSpecial the given method. This method will require at least Java 7, but since the source has to compile on older Java versions as well it is not marked to return a MethodHandle and uses Object instead Returns:Object null in case of jdk<7, otherwise a handle that takes the method call arguments for the invokespecial call

getInvokeSpecialHandle

back to summary

public Object getInvokeSpecialHandle(Method m, Object receiver)

Returns a handle with bound receiver to invokeSpecial the given method. This method will require at least Java 7, but since the source has to compile on older Java versions as well it is not marked to return a MethodHandle and uses Object instead

Returns:Object: null in case of jdk<7, otherwise a handle that takes the method call arguments for the invokespecial call

getPluginDefaultGroovyMethods	back to summary
public Class<T>[] getPluginDefaultGroovyMethods()

getPluginStaticGroovyMethods	back to summary
public Class<T>[] getPluginStaticGroovyMethods()

getVersion	back to summary
public int getVersion() Gives the version the plugin is made for Returns:int 7 for jdk7, 8 for jdk8, 9 for jdk9 or higher

getVersion

back to summary

public int getVersion()

Gives the version the plugin is made for

Returns:int: 7 for jdk7, 8 for jdk8, 9 for jdk9 or higher

invalidateCallSites	back to summary
public void invalidateCallSites()

invokeHandle	back to summary
public Object invokeHandle(Object handle, Object[] args) throws Throwable Invokes a handle produced by #getInvokeSpecialdHandle Parameters handle:Object the handle args:Object[] arguments for the method call, can be empty but not null Returns:Object the result of the method call

invokeHandle

back to summary

public Object invokeHandle(Object handle, Object[] args) throws Throwable

Invokes a handle produced by #getInvokeSpecialdHandle

Parameters

handle:Object: the handle
args:Object[]: arguments for the method call, can be empty but not null

Returns:Object

the result of the method call

setAdditionalClassInformation	back to summary
public void setAdditionalClassInformation(ClassNode c)

transformMetaMethod	back to summary
public MetaMethod transformMetaMethod(MetaClass metaClass, MetaMethod metaMethod, Class<?> caller) transform meta method Parameters metaClass:MetaClass meta class metaMethod:MetaMethod the original meta method caller:Class<?> caller class, whose method sets accessible for methods Returns:MetaMethod the transformed meta method

transformMetaMethod

back to summary

public MetaMethod transformMetaMethod(MetaClass metaClass, MetaMethod metaMethod, Class<?> caller)

transform meta method

Parameters

metaClass:MetaClass: meta class
metaMethod:MetaMethod: the original meta method
caller:Class<?>: caller class, whose method sets accessible for methods

Returns:MetaMethod

the transformed meta method

transformMetaMethod	back to summary
public MetaMethod transformMetaMethod(MetaClass metaClass, MetaMethod metaMethod) transform meta method. Parameters metaClass:MetaClass meta class metaMethod:MetaMethod the original meta method Returns:MetaMethod the transformed meta method

transformMetaMethod

back to summary

public MetaMethod transformMetaMethod(MetaClass metaClass, MetaMethod metaMethod)

transform meta method.

Parameters

metaClass:MetaClass: meta class
metaMethod:MetaMethod: the original meta method

Returns:MetaMethod

the transformed meta method

trySetAccessible back to summary

trySetAccessible	back to summary
public boolean trySetAccessible(AccessibleObject ao) Set the `accessible` flag for this reflected object to `true` if possible. Parameters ao:AccessibleObject the accessible object Returns:boolean `true` if the `accessible` flag is set to `true`; `false` if access cannot be enabled. Exceptions SecurityException: if the request is denied by the security manager

public boolean trySetAccessible(AccessibleObject ao)

Set the accessible flag for this reflected object to true if possible.

Parameters

ao:AccessibleObject: the accessible object

Returns:boolean

true if the accessible flag is set to true; false if access cannot be enabled.

Exceptions

SecurityException:: if the request is denied by the security manager

public Interface VMPlugin

Method Summary

Method Detail