com.hpe.caf.worker.document.impl

Class ScriptsImpl

java.lang.Object

com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

com.hpe.caf.worker.document.impl.ScriptsImpl

All Implemented Interfaces:

DocumentWorkerObject, Scripts, Iterable<Script>

public final class ScriptsImpl
extends DocumentWorkerObjectImpl
implements Scripts

Field Summary

Fields inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

application

Constructor Summary

Constructors

Constructor and Description
ScriptsImpl(ApplicationImpl application, AbstractTask task)
ScriptsImpl(ApplicationImpl application, AbstractTask task, List<DocumentWorkerScript> scripts)

Method Summary

Modifier and Type	Method and Description
Script	add()
Script	add(int index)
Script	get(int index)
int	getCurrentScriptIndex(int previousIndex, ScriptImpl script) A script's position in the list could change if new scripts are inserted before it.
Task	getTask()
boolean	isEmpty()
Iterator<Script>	iterator()
void	loadAll()
void	raiseEvent(String event, boolean useReverseOrder, Object... args) Raises the specified event in all loaded scripts.
void	raiseEventUntil(String event, boolean useReverseOrder, BooleanSupplier condition, Object... args) Raises the specified event in all of the loaded scripts, or until the specified condition is met.
int	size()
Stream<Script>	stream()
Stream<ScriptImpl>	streamImpls()
void	uninstallAll()
void	unloadAll()

Methods inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

getApplication

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ScriptsImpl

public ScriptsImpl(ApplicationImpl application,
                   AbstractTask task)

ScriptsImpl

public ScriptsImpl(ApplicationImpl application,
                   AbstractTask task,
                   List<DocumentWorkerScript> scripts)
            throws InvalidScriptException

Throws:

InvalidScriptException

Method Detail

add

@Nonnull
public Script add()

Specified by:

add in interface Scripts

add

@Nonnull
public Script add(int index)

Specified by:

add in interface Scripts

get

@Nonnull
public Script get(int index)

Specified by:

get in interface Scripts

getTask

@Nonnull
public Task getTask()

Specified by:

getTask in interface Scripts

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Scripts

size

public int size()

Specified by:

size in interface Scripts

stream

@Nonnull
public Stream<Script> stream()

Specified by:

stream in interface Scripts

streamImpls

@Nonnull
public Stream<ScriptImpl> streamImpls()

iterator

@Nonnull
public Iterator<Script> iterator()

Specified by:

iterator in interface Iterable<Script>

uninstallAll

public void uninstallAll()

Specified by:

uninstallAll in interface Scripts

getCurrentScriptIndex

public int getCurrentScriptIndex(int previousIndex,
                                 ScriptImpl script)

A script's position in the list could change if new scripts are inserted before it. This function takes the script's last known list position and finds its current position. There is no facility for the script object to be removed from the list or to move to an earlier position in the list so it should always be found, and we can start the search from the last known position.

Parameters:

previousIndex - the index to start searching from; use 0 if it is not known

script - the script to look for, which must be in the list of scripts

Returns:

the current index of the script

loadAll

public void loadAll()
             throws ScriptException

Throws:

ScriptException

unloadAll

public void unloadAll()

raiseEvent

public void raiseEvent(String event,
                       boolean useReverseOrder,
                       Object... args)

Raises the specified event in all loaded scripts.

Parameters:

event - the event to be raised

useReverseOrder - controls the order in which the loaded scripts are called

args - the arguments to be passed to the specified event

raiseEventUntil

public void raiseEventUntil(String event,
                            boolean useReverseOrder,
                            BooleanSupplier condition,
                            Object... args)

Raises the specified event in all of the loaded scripts, or until the specified condition is met.

Parameters:

event - the event to be raised

useReverseOrder - controls the order in which the loaded scripts are called

condition - a condition which causes the event to stop being raised in the remaining scripts

args - the arguments to be passed to the specified event