Apache Groovy 3.0.20 · org.codehaus.groovy.runtime.InvokerHelper

Modifier and Type	Class and Description
pack-priv static class	InvokerHelper.NullScript

Modifier and Type	Field and Description
private static final Set<String>	DEFAULT_IMPORT_CLASSES
private static final Set<String>	DEFAULT_IMPORT_PKGS
public static final Object[]	EMPTY_ARGS
protected static final Object[]	EMPTY_ARGUMENTS
protected static final Class<T>[]	EMPTY_TYPES
private static final int	ITEM_ALLOCATE_SIZE
public static final String	MAIN_METHOD_NAME
public static final MetaClassRegistry	metaRegistry
private static final String	SERIALIZE_METHOD_NAME
private static final String	XMLUTIL_CLASS_FULL_NAME

Access	Constructor and Description
public	InvokerHelper()

Method Summary

Modifier and Type	Method and Description
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
public static Iterator<Object>	asIterator(Object o)
public static List<E>	asList(Object value)
public static void	assertFailed(Object expression, Object message)
public static Object[]	asUnwrappedArray(Object arguments)
public static Object	bitwiseNegate(Object value)
public static List<E>	createList(Object[] values)
public static Map<K, V>	createMap(Object[] values)
public static List<E>	createRange(Object from, Object to, boolean inclusive)
public static Script	createScript(final Class<T> scriptClass, final Binding context)
public static Tuple<E>	createTuple(Object[] array)
public static String	escapeBackslashes(String orig)
public static Matcher	findRegex(Object string to compare left, Object regular expression to compare the string to right) Find the right hand regex within the left hand string and return a matcher.
protected static String	format(Object arguments, boolean verbose)
public static String	format(Object arguments, boolean verbose, int maxSize)
public static String	format(Object arguments, boolean verbose, int maxSize, boolean safe)
private static String	formatCollection(Collection<E> collection, boolean verbose, int maxSize, boolean safe)
private static String	formatMap(Map<K, V> map, boolean verbose, int maxSize, boolean safe)
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<T> cls)
public static MetaClassRegistry	getMetaRegistry()
public static Closure<V>	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)
private static String	handleFormattingException(Object item, Exception ex)
public static int	Returns: the initial capacity initialCapacity(int the initial entry count initialEntryCnt) According to the initial entry count, calculate the initial capacity of hash map, which is power of 2 (SEE https://stackoverflow.com/questions/8352378/why-does-hashmap-require-that-the-initial-capacity-be-a-power-of-two)
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<T> 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<T> type)
pack-priv static Object	invokePogoMethod(Object object, String methodName, Object arguments)
pack-priv static Object	invokePojoMethod(Object object, String methodName, Object arguments)
public static Object	invokeStaticMethod(String klass, String methodName, Object arguments)
public static Object	invokeStaticMethod(Class<T> type, String method, Object arguments)
public static Object	invokeStaticNoArgumentsMethod(Class<T> type, String methodName)
public static Object	invokeSuperMethod(Object object, String methodName, Object arguments)
public static boolean	matchRegex(Object string to compare left, Object regular expression to compare the string to right) Find the right hand regex within the left hand string and return a matcher.
public static Script	newScript(Class<?> scriptClass, Binding context)
public static void	removeClass(Class<T> clazz)
public static Object	runScript(Class<T> 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.
public static void	setProperties(Object object, Map<K, V> 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.
private static void	setPropertySafe(Object object, MetaClass mc, String key, Object value)
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.
private static int	sizeLeft(int maxSize, StringBuilder buffer)
public static SpreadMap	spreadMap(Object value)
public static String	Returns: the string representation of the array toArrayString(Object[] the array to process arguments) A helper method to return the string representation of an array of objects with brace boundaries "[" and "]".
private static String	toArrayString(Object[] array, boolean verbose, int maxSize, boolean safe)
public static String	Returns: the string representation of the array toArrayString(Object[] the array to process arguments, int stop after approximately this many characters and append '...' maxSize, boolean whether to use a default object representation for any item in the array if an exception occurs when generating its toString safe) A helper method to return the string representation of an array of objects with brace boundaries "[" and "]".
public static String	Returns: the string representation of the collection toListString(Collection<E> the collection to process arg) A helper method to return the string representation of a list with bracket boundaries "[" and "]".
public static String	Returns: the string representation of the collection toListString(Collection<E> the collection to process arg, int stop after approximately this many characters and append '...' maxSize) A helper method to return the string representation of a list with bracket boundaries "[" and "]".
public static String	Returns: the string representation of the collection toListString(Collection<E> the collection to process arg, int stop after approximately this many characters and append '...', -1 means don't stop maxSize, boolean whether to use a default object representation for any item in the collection if an exception occurs when generating its toString safe) A helper method to return the string representation of a list with bracket boundaries "[" and "]".
public static String	Returns: the string representation of the map toMapString(Map<K, V> the map to process arg) A helper method to return the string representation of a map with bracket boundaries "[" and "]".
public static String	Returns: the string representation of the map toMapString(Map<K, V> the map to process arg, int stop after approximately this many characters and append '...', -1 means don't stop maxSize) A helper method to return the string representation of a map with bracket boundaries "[" and "]".
public static String	toString(Object arguments)
public static String	Returns: the string representation of the type toTypeString(Object[] the type to process arguments) A helper method to format the arguments types as a comma-separated list.
public static String	Returns: the string representation of the type toTypeString(Object[] the type to process arguments, int stop after approximately this many characters and append '...', -1 means don't stop maxSize) A helper method to format the arguments types as a comma-separated list.
private static String	Returns: the type name (slightly pretty format taking into account default imports) typeName(Object the object to find the type for argument) Gets the type name
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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_IMPORT_CLASSES	back to summary
private static final Set<String> DEFAULT_IMPORT_CLASSES

DEFAULT_IMPORT_PKGS	back to summary
private static final Set<String> DEFAULT_IMPORT_PKGS

EMPTY_ARGS	back to summary
public static final Object[] EMPTY_ARGS

EMPTY_ARGUMENTS	back to summary
protected static final Object[] EMPTY_ARGUMENTS

EMPTY_TYPES	back to summary
protected static final Class<T>[] EMPTY_TYPES

ITEM_ALLOCATE_SIZE	back to summary
private static final int ITEM_ALLOCATE_SIZE

MAIN_METHOD_NAME	back to summary
public static final String MAIN_METHOD_NAME

metaRegistry	back to summary
public static final MetaClassRegistry metaRegistry

SERIALIZE_METHOD_NAME	back to summary
private static final String SERIALIZE_METHOD_NAME

XMLUTIL_CLASS_FULL_NAME	back to summary
private static final String XMLUTIL_CLASS_FULL_NAME

InvokerHelper	back to summary
public InvokerHelper()

Method Detail

append	back to summary
public static void append(Appendable out, Object object) throws IOException Appends an object to an Appendable using Groovy's default representation for the object.

asArray	back to summary
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

asIterator	back to summary
public static Iterator<Object> asIterator(Object o) Annotations @SuppressWarnings:unchecked

asList	back to summary
public static List<E> asList(Object value)

assertFailed	back to summary
public static void assertFailed(Object expression, Object message)

asUnwrappedArray	back to summary
public static Object[] asUnwrappedArray(Object arguments)

bitwiseNegate	back to summary
public static Object bitwiseNegate(Object value)

createList	back to summary
public static List<E> createList(Object[] values)

createMap	back to summary
public static Map<K, V> createMap(Object[] values)

createRange	back to summary
public static List<E> createRange(Object from, Object to, boolean inclusive)

createScript	back to summary
public static Script createScript(final Class<T> scriptClass, final Binding context) Annotations @SuppressWarnings:unchecked

createTuple	back to summary
public static Tuple<E> createTuple(Object[] array)

escapeBackslashes	back to summary
public static String escapeBackslashes(String orig)

findRegex	back to summary
public static Matcher findRegex(Object left, Object right) Find the right hand regex within the left hand string and return a matcher. Parameters left:Object string to compare right:Object regular expression to compare the string to

findRegex

back to summary

public static Matcher findRegex(Object left, Object right)

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

Parameters

left:Object: string to compare
right:Object: regular expression to compare the string to

format	back to summary
protected static String format(Object arguments, boolean verbose)

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

format	back to summary
public static String format(Object arguments, boolean verbose, int maxSize, boolean safe)

formatCollection	back to summary
private static String formatCollection(Collection<E> collection, boolean verbose, int maxSize, boolean safe)

formatMap	back to summary
private static String formatMap(Map<K, V> map, boolean verbose, int maxSize, boolean safe)

getAttribute	back to summary
public static Object getAttribute(Object object, String attribute)

getGroovyObjectProperty	back to summary
public static Object getGroovyObjectProperty(GroovyObject object, String property)

getMetaClass	back to summary
public static MetaClass getMetaClass(Object object)

getMetaClass	back to summary
public static MetaClass getMetaClass(Class<T> cls)

getMetaRegistry	back to summary
public static MetaClassRegistry getMetaRegistry()

getMethodPointer	back to summary
public static Closure<V> getMethodPointer(Object object, String methodName) Returns the method pointer for the given object name

getProperty	back to summary
public static Object getProperty(Object object, String property)

getPropertySafe	back to summary
public static Object getPropertySafe(Object object, String property)

handleFormattingException	back to summary
private static String handleFormattingException(Object item, Exception ex)

initialCapacity	back to summary
public static int initialCapacity(int initialEntryCnt) According to the initial entry count, calculate the initial capacity of hash map, which is power of 2 (SEE https://stackoverflow.com/questions/8352378/why-does-hashmap-require-that-the-initial-capacity-be-a-power-of-two) Parameters initialEntryCnt:int the initial entry count Returns:int the initial capacity

initialCapacity

back to summary

public static int initialCapacity(int initialEntryCnt)

According to the initial entry count, calculate the initial capacity of hash map, which is power of 2 (SEE https://stackoverflow.com/questions/8352378/why-does-hashmap-require-that-the-initial-capacity-be-a-power-of-two)

Parameters

initialEntryCnt:int: the initial entry count

Returns:int

the initial capacity

inspect	back to summary
public static String inspect(Object self)

invokeClosure	back to summary
public static Object invokeClosure(Object closure, Object arguments)

invokeConstructorOf	back to summary
public static Object invokeConstructorOf(String klass, Object arguments) throws ClassNotFoundException

invokeConstructorOf	back to summary
public static Object invokeConstructorOf(Class<T> type, Object arguments)

invokeMethod	back to summary
public static Object invokeMethod(Object object, String methodName, Object arguments) Invokes the given method on the object.

invokeMethodSafe	back to summary
public static Object invokeMethodSafe(Object object, String methodName, Object arguments)

invokeNoArgumentsConstructorOf	back to summary
public static Object invokeNoArgumentsConstructorOf(Class<T> type)

invokePogoMethod	back to summary
pack-priv static Object invokePogoMethod(Object object, String methodName, Object arguments)

invokePojoMethod	back to summary
pack-priv static Object invokePojoMethod(Object object, String methodName, Object arguments)

invokeStaticMethod	back to summary
public static Object invokeStaticMethod(String klass, String methodName, Object arguments) throws ClassNotFoundException

invokeStaticMethod	back to summary
public static Object invokeStaticMethod(Class<T> type, String method, Object arguments)

invokeStaticNoArgumentsMethod	back to summary
public static Object invokeStaticNoArgumentsMethod(Class<T> type, String methodName)

invokeSuperMethod	back to summary
public static Object invokeSuperMethod(Object object, String methodName, Object arguments)

matchRegex

back to summary

public static boolean matchRegex(Object left, Object right)

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

Parameters

left:Object: string to compare
right:Object: regular expression to compare the string to

newScript	back to summary
public static Script newScript(Class<?> scriptClass, Binding context) throws InstantiationException, IllegalAccessException, InvocationTargetException

removeClass	back to summary
public static void removeClass(Class<T> clazz)

runScript	back to summary
public static Object runScript(Class<T> scriptClass, String[] args)

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

setGroovyObjectProperty	back to summary
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.

setProperties	back to summary
public static void setProperties(Object object, Map<K, V> map) Sets the properties on the given object

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

setProperty2	back to summary
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.

setPropertySafe	back to summary
private static void setPropertySafe(Object object, MetaClass mc, String key, Object value)

setPropertySafe2	back to summary
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.

sizeLeft	back to summary
private static int sizeLeft(int maxSize, StringBuilder buffer)

spreadMap	back to summary
public static SpreadMap spreadMap(Object value)

toArrayString

back to summary

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:Object[]: the array to process

Returns:String

the string representation of the array

toArrayString	back to summary
private static String toArrayString(Object[] array, boolean verbose, int maxSize, boolean safe)

toArrayString

back to summary

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:Object[]: the array to process
maxSize:int: stop after approximately this many characters and append '...'
safe:boolean: whether to use a default object representation for any item in the array if an exception occurs when generating its toString

Returns:String

the string representation of the array

toListString

back to summary

public static String toListString(Collection<E> arg)

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

Parameters

arg:Collection<E>: the collection to process

Returns:String

the string representation of the collection

toListString

back to summary

public static String toListString(Collection<E> arg, int maxSize)

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

Parameters

arg:Collection<E>: the collection to process
maxSize:int: stop after approximately this many characters and append '...'

Returns:String

the string representation of the collection

toListString

back to summary

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

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

Parameters

arg:Collection<E>: the collection to process
maxSize:int: stop after approximately this many characters and append '...', -1 means don't stop
safe:boolean: whether to use a default object representation for any item in the collection if an exception occurs when generating its toString

Returns:String

the string representation of the collection

toMapString

back to summary

public static String toMapString(Map<K, V> arg)

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

Parameters

arg:Map<K, V>: the map to process

Returns:String

the string representation of the map

toMapString

back to summary

public static String toMapString(Map<K, V> arg, int maxSize)

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

Parameters

arg:Map<K, V>: the map to process
maxSize:int: stop after approximately this many characters and append '...', -1 means don't stop

Returns:String

the string representation of the map

toString	back to summary
public static String toString(Object arguments)

toTypeString

back to summary

public static String toTypeString(Object[] arguments)

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

Parameters

arguments:Object[]: the type to process

Returns:String

the string representation of the type

toTypeString

back to summary

public static String toTypeString(Object[] arguments, int maxSize)

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

Parameters

arguments:Object[]: the type to process
maxSize:int: stop after approximately this many characters and append '...', -1 means don't stop

Returns:String

the string representation of the type

typeName

back to summary

private static String typeName(Object argument)

Gets the type name

Parameters

argument:Object: the object to find the type for

Returns:String

the type name (slightly pretty format taking into account default imports)

unaryMinus	back to summary
public static Object unaryMinus(Object value)

unaryPlus	back to summary
public static Object unaryPlus(Object value)

write	back to summary
public static void write(Writer out, Object object) throws IOException Writes an object to a Writer using Groovy's default representation for the object.

public Class InvokerHelper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class InvokerHelper.NullScript

Constructor Summary

Method Summary

Constructor Detail

Method Detail