org.appformer.kogito.bridge.client.stateControl.registry.interop

Interface KogitoJSCommandRegistry<C>

Type Parameters:

C - anything that can be considered a Command

@JsType(isNative=true)
public interface KogitoJSCommandRegistry<C>

JsType that represents the TypeScript CommandRegistry available on the Envelope StateControl engine

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the registry
C[]	getCommands() Returns an array containing all the commands in the registry
boolean	isEmpty() Determines if the registry is empty or not
C	peek() Peeks the last added command.
C	pop() Pops the last added command and removes it.
void	register(String id, C command) Registers a command with a give ID into the registry
void	setMaxSize(int size) Sets the max number of commands that can be stored on the registry.
void	setRegistryChangeListener(StateControlCommand changeListener) Sets a StateControlCommand to be called when the registry changes.

Method Detail

register

void register(String id,
              C command)

Registers a command with a give ID into the registry

Parameters:

id - The command id

command - A command to register

peek

C peek()

Peeks the last added command. Doesn't remove it.

Returns:

The last added Command

pop

C pop()

Pops the last added command and removes it.

Returns:

The last added Command

setMaxSize

void setMaxSize(int size)

Sets the max number of commands that can be stored on the registry.

Parameters:

size - A positive integer

clear

void clear()

Clears the registry

isEmpty

boolean isEmpty()

Determines if the registry is empty or not

Returns:

true if empty, false if not.

getCommands

C[] getCommands()

Returns an array containing all the commands in the registry

Returns:

A commands array

setRegistryChangeListener

void setRegistryChangeListener(StateControlCommand changeListener)

Sets a StateControlCommand to be called when the registry changes.

Parameters:

changeListener - A StateControlCommand