@ConsumerType public interface SlingScript
SlingScript
defines the API for objects which encapsulate
a script. To evaluate a script prepare a SlingBindings
instance of
variables used as global variables to the script and call the
eval(SlingBindings)
method.
You can obtain scripts by resolving a script resource through
ResourceResolver.resolve(String)
and then trying to adapt the resource to a script by
calling Adaptable.adaptTo(Class)
.
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
call(@NotNull SlingBindings props,
@NotNull java.lang.String method,
java.lang.Object... args)
Evaluates this script using the bound variables as global variables to
the script and then calls the given method with the arguments.
|
java.lang.Object |
eval(@NotNull SlingBindings props)
Evaluates this script using the bound variables as global variables to
the script.
|
@NotNull Resource |
getScriptResource()
Returns the Resource providing the script source code.
|
@NotNull @NotNull Resource getScriptResource()
java.lang.Object eval(@NotNull @NotNull SlingBindings props)
props
- The SlingBindings
providing the bound variables for
evaluating the script. Any bound variables must conform to the
requirements of the SlingBindings
predefined variables
set.ScriptEvaluationException
- If an error occurs executing the
script or preparing the script execution. The cause of the
evaluation exception is available as the exception cause.java.lang.Object call(@NotNull @NotNull SlingBindings props, @NotNull @NotNull java.lang.String method, java.lang.Object... args)
props
- The SlingBindings
providing the bound variables for
evaluating the script. Any bound variables must conform to the
requirements of the SlingBindings
predefined variables
set.method
- The name of the method to call.args
- The arguments for the method call.ScriptEvaluationException
- If an error occurs executing the
script or preparing the script execution. The cause of the
evaluation exception is available as the exception cause.Copyright © 2010 - 2020 Adobe. All Rights Reserved