[Java] Class InvokerHelper

  • org.codehaus.groovy.runtime.InvokerHelper

A static helper class to make bytecode generation easier and act as a facade over the Invoker

Authors:
James Strachan

Field Summary

Fields
Modifiers Name Description
static Object[] EMPTY_ARGS
protected static Object[] EMPTY_ARGUMENTS
protected static Class[] EMPTY_TYPES
static MetaClassRegistry metaRegistry

Methods Summary

Methods
Type Params Return Type Name and description
static void append(Appendable out, Object object)
Appends an object to an Appendable using Groovy's default representation for the object.
static Object[] asArray(Object arguments)
Converts the given object into an array; if its an array then just cast otherwise wrap it in an array
static Iterator<Object> asIterator(Object o)
static List asList(Object value)
static Object[] asUnwrappedArray(Object arguments)
static void assertFailed(Object expression, Object message)
static Object bitwiseNegate(Object value)
static List createList(Object[] values)
static Map createMap(Object[] values)
static List createRange(Object from, Object to, boolean inclusive)
static Script createScript(Class scriptClass, Binding context)
static Tuple createTuple(Object[] array)
static String escapeBackslashes(String orig)
static Matcher findRegex(Object left, Object right)
Find the right hand regex within the left hand string and return a matcher.
protected static String format(Object arguments, boolean verbose)
static String format(Object arguments, boolean verbose, int maxSize)
static Object getAttribute(Object object, String attribute)
static Object getGroovyObjectProperty(GroovyObject object, String property)
static MetaClass getMetaClass(Object object)
static MetaClass getMetaClass(Class cls)
static MetaClassRegistry getMetaRegistry()
static Closure getMethodPointer(Object object, String methodName)
Returns the method pointer for the given object name
static Object getProperty(Object object, String property)
static Object getPropertySafe(Object object, String property)
static String inspect(Object self)
static Object invokeClosure(Object closure, Object arguments)
static Object invokeConstructorOf(String klass, Object arguments)
static Object invokeConstructorOf(Class type, Object arguments)
static Object invokeMethod(Object object, String methodName, Object arguments)
Invokes the given method on the object.
static Object invokeMethodSafe(Object object, String methodName, Object arguments)
static Object invokeNoArgumentsConstructorOf(Class type)
static Object invokeStaticMethod(String klass, String methodName, Object arguments)
static Object invokeStaticMethod(Class type, String method, Object arguments)
static Object invokeStaticNoArgumentsMethod(Class type, String methodName)
static Object invokeSuperMethod(Object object, String methodName, Object arguments)
static boolean matchRegex(Object left, Object right)
Find the right hand regex within the left hand string and return a matcher.
static Script newScript(Class scriptClass, Binding context)
static void removeClass(Class clazz)
static Object runScript(Class scriptClass, String[] args)
static void setAttribute(Object object, String attribute, Object newValue)
static void setGroovyObjectProperty(Object newValue, GroovyObject object, String property)
This is so we don't have to reorder the stack when we call this method.
static void setProperties(Object object, Map map)
Sets the properties on the given object
static void setProperty(Object object, String property, Object newValue)
static void setProperty2(Object newValue, Object object, String property)
This is so we don't have to reorder the stack when we call this method.
static void setPropertySafe2(Object newValue, Object object, String property)
This is so we don't have to reorder the stack when we call this method.
static SpreadMap spreadMap(Object value)
static String toArrayString(Object[] arguments)
A helper method to return the string representation of an array of objects with brace boundaries "[" and "]".
static String toArrayString(Object[] arguments, int maxSize, boolean safe)
A helper method to return the string representation of an array of objects with brace boundaries "[" and "]".
static String toListString(Collection arg)
A helper method to return the string representation of a list with bracket boundaries "[" and "]".
static String toListString(Collection arg, int maxSize)
A helper method to return the string representation of a list with bracket boundaries "[" and "]".
static String toListString(Collection arg, int maxSize, boolean safe)
A helper method to return the string representation of a list with bracket boundaries "[" and "]".
static String toMapString(Map arg)
A helper method to return the string representation of a map with bracket boundaries "[" and "]".
static String toMapString(Map arg, int maxSize)
A helper method to return the string representation of a map with bracket boundaries "[" and "]".
static String toString(Object arguments)
static String toTypeString(Object[] arguments)
A helper method to format the arguments types as a comma-separated list.
static Object unaryMinus(Object value)
static Object unaryPlus(Object value)
static void write(Writer out, Object object)
Writes an object to a Writer using Groovy's default representation for the object.

Inherited Methods Summary

Inherited Methods
Methods inherited from class Name
class Object wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Field Detail

public static final Object[] EMPTY_ARGS

protected static final Object[] EMPTY_ARGUMENTS

protected static final Class[] EMPTY_TYPES

public static final MetaClassRegistry metaRegistry

Method Detail

public static void append(Appendable out, Object object)

Appends an object to an Appendable using Groovy's default representation for the object.

public static Object[] asArray(Object arguments)

Converts the given object into an array; if its an array then just cast otherwise wrap it in an array

@SuppressWarnings("unchecked") public static Iterator<Object> asIterator(Object o)

public static List asList(Object value)

public static Object[] asUnwrappedArray(Object arguments)

public static void assertFailed(Object expression, Object message)

public static Object bitwiseNegate(Object value)

public static List createList(Object[] values)

public static Map createMap(Object[] values)

public static List createRange(Object from, Object to, boolean inclusive)

public static Script createScript(Class scriptClass, Binding context)

public static Tuple createTuple(Object[] array)

public static String escapeBackslashes(String orig)

public static Matcher findRegex(Object left, Object right)

Find the right hand regex within the left hand string and return a matcher.

Parameters:
left - string to compare
right - regular expression to compare the string to

protected static String format(Object arguments, boolean verbose)

public static String format(Object arguments, boolean verbose, int maxSize)

public static Object getAttribute(Object object, String attribute)

public static Object getGroovyObjectProperty(GroovyObject object, String property)

public static MetaClass getMetaClass(Object object)

public static MetaClass getMetaClass(Class cls)

public static MetaClassRegistry getMetaRegistry()

public static Closure getMethodPointer(Object object, String methodName)

Returns the method pointer for the given object name

public static Object getProperty(Object object, String property)

public static Object getPropertySafe(Object object, String property)

public static String inspect(Object self)

public static Object invokeClosure(Object closure, Object arguments)

public static Object invokeConstructorOf(String klass, Object arguments)

public static Object invokeConstructorOf(Class type, Object arguments)

public static Object invokeMethod(Object object, String methodName, Object arguments)

Invokes the given method on the object.

public static Object invokeMethodSafe(Object object, String methodName, Object arguments)

public static Object invokeNoArgumentsConstructorOf(Class type)

public static Object invokeStaticMethod(String klass, String methodName, Object arguments)

public static Object invokeStaticMethod(Class type, String method, Object arguments)

public static Object invokeStaticNoArgumentsMethod(Class type, String methodName)

public static Object invokeSuperMethod(Object object, String methodName, Object arguments)

public static boolean matchRegex(Object left, Object right)

Find the right hand regex within the left hand string and return a matcher.

Parameters:
left - string to compare
right - regular expression to compare the string to

public static Script newScript(Class scriptClass, Binding context)

public static void removeClass(Class clazz)

public static Object runScript(Class scriptClass, String[] args)

public static void setAttribute(Object object, String attribute, Object newValue)

public static void setGroovyObjectProperty(Object newValue, GroovyObject object, String property)

This is so we don't have to reorder the stack when we call this method. At some point a better name might be in order.

public static void setProperties(Object object, Map map)

Sets the properties on the given object

public static void setProperty(Object object, String property, Object newValue)

public static void setProperty2(Object newValue, Object object, String property)

This is so we don't have to reorder the stack when we call this method. At some point a better name might be in order.

public static void setPropertySafe2(Object newValue, Object object, String property)

This is so we don't have to reorder the stack when we call this method. At some point a better name might be in order.

public static SpreadMap spreadMap(Object value)

public static String toArrayString(Object[] arguments)

A helper method to return the string representation of an array of objects with brace boundaries "[" and "]".

Parameters:
arguments - the array to process
Returns:
the string representation of the array

public static String toArrayString(Object[] arguments, int maxSize, boolean safe)

A helper method to return the string representation of an array of objects with brace boundaries "[" and "]".

Parameters:
arguments - the array to process
maxSize - stop after approximately this many characters and append '...'
safe - whether to use a default object representation for any item in the array if an exception occurs when generating its toString
Returns:
the string representation of the array

public static String toListString(Collection arg)

A helper method to return the string representation of a list with bracket boundaries "[" and "]".

Parameters:
arg - the collection to process
Returns:
the string representation of the collection

public static String toListString(Collection arg, int maxSize)

A helper method to return the string representation of a list with bracket boundaries "[" and "]".

Parameters:
arg - the collection to process
maxSize - stop after approximately this many characters and append '...'
Returns:
the string representation of the collection

public static String toListString(Collection arg, int maxSize, boolean safe)

A helper method to return the string representation of a list with bracket boundaries "[" and "]".

Parameters:
arg - the collection to process
maxSize - stop after approximately this many characters and append '...'
safe - whether to use a default object representation for any item in the collection if an exception occurs when generating its toString
Returns:
the string representation of the collection

public static String toMapString(Map arg)

A helper method to return the string representation of a map with bracket boundaries "[" and "]".

Parameters:
arg - the map to process
Returns:
the string representation of the map

public static String toMapString(Map arg, int maxSize)

A helper method to return the string representation of a map with bracket boundaries "[" and "]".

Parameters:
arg - the map to process
maxSize - stop after approximately this many characters and append '...'
Returns:
the string representation of the map

public static String toString(Object arguments)

public static String toTypeString(Object[] arguments)

A helper method to format the arguments types as a comma-separated list.

Parameters:
arguments - the type to process
Returns:
the string representation of the type

public static Object unaryMinus(Object value)

public static Object unaryPlus(Object value)

public static void write(Writer out, Object object)

Writes an object to a Writer using Groovy's default representation for the object.

© 2003-2020 The Apache Software Foundation
Licensed under the Apache license.
https://docs.groovy-lang.org/2.4.21/html/gapi/org/codehaus/groovy/runtime/InvokerHelper.html