org.scripthelper.model

Interface ScriptMethodInvoker

All Known Subinterfaces:

DebuggingWrapper<S>, ScriptWrapper<S>

All Known Implementing Classes:

AbstractDebuggingScriptWrapper, AbstractScriptWrapper, GroovyScriptWrapper, JSScriptWrapper, PythonScriptWrapper, RubyScriptWrapper, ScriptWrapperCombiner

public interface ScriptMethodInvoker

This interface denotes script wrappers which allow to invoke directly methods without having to limit to the Script interface.

Since:

1.5

Method Summary

Modifier and Type	Method and Description
default void	cacheInvocableMethods() Cache the invocable methods for the current installed script.
default java.util.Set<CachedMethodKey>	getInvocableMethods() Return the invocable methods for the current installed script.
default java.util.Map<java.lang.String,java.util.Set<CachedMethodKey>>	getInvocableMethodsByNames() Return the invocable methods sorted by their names for the current installed script.
default boolean	hasInvocableMethod(CachedMethodKey key) Return true if the invoker has an invocation method of a specific key.
default java.lang.Object	invokeMethod(java.lang.String name) Invoke directly a method without arguments by reflection for the current installed script.
default java.lang.Object	invokeMethod(java.lang.String name, java.lang.Object... args) Invoke directly a method by reflection for the current installed script.
default boolean	isAutoCachingInvocableMethods() Return true if a cache of invocable methods will be created each time the wrapper installs a new script.
default boolean	isInvocableByName() Return true if only the name of the method is significant.
default boolean	isInvocableMethodsEnabled() Return true if invocable methods are enabled for this wrapper.
default void	setAutoCacheInvocableMethods(boolean autoCache) Set if a cache of invocable methods will be created each time the wrapper installs a new script.

Method Detail

isInvocableMethodsEnabled

default boolean isInvocableMethodsEnabled()

Return true if invocable methods are enabled for this wrapper. If this is the case, the method invokeMethod(java.lang.String, java.lang.Object...) will be implemented for the wrapper. Return false by default.

Returns:

true if invocable methods are enabled for this wrapper

isAutoCachingInvocableMethods

default boolean isAutoCachingInvocableMethods()

Return true if a cache of invocable methods will be created each time the wrapper installs a new script. Return false by default.

Returns:

true if a cache of invocable methods will be created each time the wrapper installs a new script

setAutoCacheInvocableMethods

default void setAutoCacheInvocableMethods(boolean autoCache)

Set if a cache of invocable methods will be created each time the wrapper installs a new script. Do nothing by default.

Parameters:

autoCache - true if a cache of invocable methods will be created each time the wrapper installs a new script

cacheInvocableMethods

default void cacheInvocableMethods()

Cache the invocable methods for the current installed script. Do nothing by default.

getInvocableMethods

default java.util.Set<CachedMethodKey> getInvocableMethods()

Return the invocable methods for the current installed script. Return an empty set by default.

Returns:

the invocable methods

getInvocableMethodsByNames

default java.util.Map<java.lang.String,java.util.Set<CachedMethodKey>> getInvocableMethodsByNames()

Return the invocable methods sorted by their names for the current installed script. Return an empty Map by default.

Returns:

the invocable methods sorted by their names

isInvocableByName

default boolean isInvocableByName()

Return true if only the name of the method is significant. Return false by default.

Returns:

true if only the name of the method is significant

hasInvocableMethod

default boolean hasInvocableMethod(CachedMethodKey key)

Return true if the invoker has an invocation method of a specific key.

Parameters:

key - the key

Returns:

true if the invoker has an invocation method of the specific key

invokeMethod

default java.lang.Object invokeMethod(java.lang.String name,
                                      java.lang.Object... args)

Invoke directly a method by reflection for the current installed script. Return an UnsupportedOperationException by default.

Parameters:

name - the method name

args - the method arguments

Returns:

the returned value

invokeMethod

default java.lang.Object invokeMethod(java.lang.String name)

Invoke directly a method without arguments by reflection for the current installed script. Defer to invokeMethod(java.lang.String, java.lang.Object...) with an empty arguments array.

Parameters:

name - the method name

Returns:

the returned value