de.ipcon.tools

Class NoOpScriptFunction

java.lang.Object

de.ipcon.tools.NoOpScriptFunction

All Implemented Interfaces:

ScriptFunctionI

public class NoOpScriptFunction
extends java.lang.Object
implements ScriptFunctionI

A no-operation function that implements ScriptFunctionI.

It is used as a placeholder for scripts that are empty or evaluate to null, allowing script caching mechanisms to work correctly without needing to store a separate null marker.

Constructor Summary

Constructors

Constructor and Description
NoOpScriptFunction() Constructs a new "NoOpScriptFunction".

Method Summary

Modifier and Type	Method and Description
java.lang.Object	invoke() Invokes the function, but does nothing and returns null.
java.lang.Object	invoke(java.lang.Object nullValue) Invokes the function, but does nothing and returns the default null value.
java.lang.Object	invoke(java.lang.Object[] parms) Invokes the function with parameters, but does nothing and returns null.
java.lang.Object	invoke(java.lang.Object[] parms, java.lang.Object nullValue) Invokes the function with parameters, but does nothing and returns the default null value.
boolean	invokeAsBool(java.lang.Object[] parms) Invokes the function with parameters, but does nothing and returns false.
boolean	invokeAsBool(java.lang.Object[] parms, boolean nullValue) Invokes the function with parameters, but does nothing and returns the default boolean null value.
java.lang.String	invokeAsString(java.lang.Object[] parms) Invokes the function with parameters, but does nothing and returns the default string null value.
java.lang.String	invokeAsString(java.lang.Object[] parms, java.lang.String nullValue) Invokes the function with parameters, but does nothing and returns the default string null value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NoOpScriptFunction

public NoOpScriptFunction()

Constructs a new "NoOpScriptFunction".

Method Detail

invoke

public java.lang.Object invoke()

Invokes the function, but does nothing and returns null.

Specified by:

invoke in interface ScriptFunctionI

Returns:

null.

invoke

public java.lang.Object invoke(java.lang.Object nullValue)

Invokes the function, but does nothing and returns the default null value.

Specified by:

invoke in interface ScriptFunctionI

Parameters:

nullValue - The nullValue to return.

Returns:

The provided nullValue.

invoke

public java.lang.Object invoke(java.lang.Object[] parms)

Invokes the function with parameters, but does nothing and returns null.

Specified by:

invoke in interface ScriptFunctionI

Parameters:

parms - The parameters to use. Unused in this implementation.

Returns:

Always returns null.

invoke

public java.lang.Object invoke(java.lang.Object[] parms,
                               java.lang.Object nullValue)

Invokes the function with parameters, but does nothing and returns the default null value.

Specified by:

invoke in interface ScriptFunctionI

Parameters:

parms - The parameters to use. Unused in this implementation.

nullValue - The default value to be returned if the function's result is null.

Returns:

The provided nullValue.

invokeAsBool

public boolean invokeAsBool(java.lang.Object[] parms)

Invokes the function with parameters, but does nothing and returns false.

Specified by:

invokeAsBool in interface ScriptFunctionI

Parameters:

parms - The parameters to use. Unused in this implementation.

Returns:

Always returns false.

invokeAsBool

public boolean invokeAsBool(java.lang.Object[] parms,
                            boolean nullValue)

Invokes the function with parameters, but does nothing and returns the default boolean null value.

Specified by:

invokeAsBool in interface ScriptFunctionI

Parameters:

parms - The parameters to use. Unused in this implementation.

nullValue - The nullValue to return.

Returns:

The provided nullValue.

invokeAsString

public java.lang.String invokeAsString(java.lang.Object[] parms)

Invokes the function with parameters, but does nothing and returns the default string null value.

Specified by:

invokeAsString in interface ScriptFunctionI

Parameters:

parms - The parameters to use. Unused in this implementation.

Returns:

Always returns null.

invokeAsString

public java.lang.String invokeAsString(java.lang.Object[] parms,
                                       java.lang.String nullValue)

Invokes the function with parameters, but does nothing and returns the default string null value.

Specified by:

invokeAsString in interface ScriptFunctionI

Parameters:

parms - The parameters to use. Unused in this implementation.

nullValue - The default String value to be returned if the function's result is null.

Returns:

The provided nullValue.