EngineOperations (Sponge - API 1.4.1 API)

All Known Subinterfaces:

KnowledgeBaseEngineOperations
```
public interface EngineOperations
```
An engine operations.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T> T`	`call(Class<T> resultClass, String actionName, Object... args)` Calls the registered action with arguments.
`Object`	`call(String actionName, Object... args)` Calls the registered action with arguments.
`EventDefinition`	`event(Event event)` Creates a new event definition.
`EventDefinition`	`event(String name)` Creates a new event definition.
`EventDefinition`	`event(String name, EventClonePolicy policy)` Creates a new event definition.
`boolean`	`existsAction(String name)` Returns `true` if an action named `name` exists.
`boolean`	`existsCorrelator(String name)` Returns `true` if a correlator named `name` exists.
`boolean`	`existsFilter(String name)` Returns `true` if a filter named `name` exists.
`boolean`	`existsRule(String name)` Returns `true` if a rule named `name` exists.
`boolean`	`existsTrigger(String name)` Returns `true` if a trigger named `name` exists.
`boolean`	`existsVariable(String name)` Returns `true` if the engine scope variable named `name` exists.
`SpongeEngine`	`getEngine()` Returns the engine.
`String`	`getInfo()` Returns the engine info.
`<T extends Plugin> T`	`getPlugin(Class<T> cls)` Returns the plugin that has the specified type or `null` if there is no such plugin.
`<T extends Plugin> T`	`getPlugin(String name)` Returns the plugin that has the specified name or `null` if there is no such plugin.
`<T extends Plugin> T`	`getPlugin(String name, Class<T> cls)` Returns the plugin that has the specified name and type or `null` if there is no such plugin.
`String`	`getStatisticsSummary()` Returns the engine statistics summary.
`<T> T`	`getVariable(Class<T> cls, String name)` Returns the value of the engine scope variable.
`<T> T`	`getVariable(Class<T> cls, String name, T defaultValue)` Returns the value of the engine scope variable or `defaultValue` if not found.
`<T> T`	`getVariable(String name)` Returns the value of the engine scope variable.
`<T> T`	`getVariable(String name, T defaultValue)` Returns the value of the engine scope variable or `defaultValue` if not found.
`String`	`getVersion()` Returns the engine version.
`Event`	`makeEvent(String name)` Creates a new named event with default clone policy.
`Event`	`makeEvent(String name, EventClonePolicy policy)` Creates a new named event with specified clone policy.
`void`	`reload()` Reloads script-based knowledge bases.
`boolean`	`removeEvent(EventSchedulerEntry entry)` Removes scheduled event.
`void`	`removeVariable(String name)` Removes the engine scope variable.
`void`	`requestReload()` Reloads script-based knowledge bases using another thread.
`void`	`requestShutdown()` Shuts down the engine using another thread.
`Event`	`send(Event event)` Sends an event to the Input Event Queue.
`Event`	`send(String eventName)` Sends a new event to the Input Event Queue.
`EventSchedulerEntry`	`sendAfter(Event event, long delay)` Sends an event to the Input Event Queue after a specified time.
`EventSchedulerEntry`	`sendAfter(Event event, long delay, long interval)` Sends an event to the Input Event Queue periodically after a specified time.
`EventSchedulerEntry`	`sendAfter(String name, long delay)` Sends a new event to the Input Event Queue after a specified time.
`EventSchedulerEntry`	`sendAfter(String name, long delay, long interval)` Sends a new event to the Input Event Queue periodically after a specified time.
`EventSchedulerEntry`	`sendAt(Event event, long milliseconds)` Sends an event to the Input Event Queue at a specified time.
`EventSchedulerEntry`	`sendAt(Event event, long milliseconds, long interval)` Sends an event to the Input Event Queue at a specified time and then periodically.
`EventSchedulerEntry`	`sendAt(Event event, String crontabSpec)` Sends an event to the Input Event Queue at a time specified by the crontab spec.
`EventSchedulerEntry`	`sendAt(String name, long milliseconds)` Sends a new event to the Input Event Queue at a specified time.
`EventSchedulerEntry`	`sendAt(String name, long milliseconds, long interval)` Sends a new event to the Input Event Queue at a specified time and then periodically.
`EventSchedulerEntry`	`sendAt(String name, String crontabSpec)` Sends a new event to the Input Event Queue at a time specified by the crontab spec.
`void`	`setVariable(String name, Object value)` Sets the engine scope variable.
`<T> void`	`setVariableIfNone(String name, Supplier<T> supplier)` Sets the engine scope variable if not set already.
`void`	`shutdown()` Shuts down the engine using the current thread.
`void`	`updateVariable(String name)` Updates the engine scope variable.

- Method Detail
  - getEngine
```
SpongeEngine getEngine()
```
    Returns the engine.
    
    Returns:
    
    the engine.
  - call
```
Object call(String actionName,
            Object... args)
```
    Calls the registered action with arguments. Throws ProcessorNotFoundException when such action is not registered.
    
    Parameters:
    
    actionName - actionName name of the action.
    
    args - arguments to pass to action.
    
    Returns:
    
    result of action called for specified arguments.
  - call
```
<T> T call(Class<T> resultClass,
           String actionName,
           Object... args)
```
    Calls the registered action with arguments. Throws ProcessorNotFoundException when such action is not registered.
    
    Type Parameters:
    
    T - result type.
    
    Parameters:
    
    resultClass - result class.
    
    actionName - actionName name of the action.
    
    args - arguments to pass to action.
    
    Returns:
    
    result of action called for specified arguments.
  - shutdown
```
void shutdown()
```
    Shuts down the engine using the current thread.
  - requestShutdown
```
void requestShutdown()
```
    Shuts down the engine using another thread.
  - reload
```
void reload()
```
    Reloads script-based knowledge bases.
  - requestReload
```
void requestReload()
```
    Reloads script-based knowledge bases using another thread.
  - send
```
Event send(Event event)
```
    Sends an event to the Input Event Queue. May throw QueueFullException if the Input Event Queue is full.
    
    Parameters:
    
    event - an event.
    
    Returns:
    
    an event.
  - send
```
Event send(String eventName)
```
    Sends a new event to the Input Event Queue. May throw QueueFullException if the Input Event Queue is full.
    
    Parameters:
    
    eventName - an event name.
    
    Returns:
    
    an event.
  - sendAfter
```
EventSchedulerEntry sendAfter(String name,
                              long delay)
```
    Sends a new event to the Input Event Queue after a specified time.
    
    Parameters:
    
    name - event name.
    
    delay - delay in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAfter
```
EventSchedulerEntry sendAfter(String name,
                              long delay,
                              long interval)
```
    Sends a new event to the Input Event Queue periodically after a specified time.
    
    Parameters:
    
    name - event name.
    
    delay - delay in milliseconds.
    
    interval - interval in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAfter
```
EventSchedulerEntry sendAfter(Event event,
                              long delay)
```
    Sends an event to the Input Event Queue after a specified time.
    
    Parameters:
    
    event - an event.
    
    delay - delay in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAfter
```
EventSchedulerEntry sendAfter(Event event,
                              long delay,
                              long interval)
```
    Sends an event to the Input Event Queue periodically after a specified time.
    
    Parameters:
    
    event - an event.
    
    delay - delay in milliseconds.
    
    interval - interval in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAt
```
EventSchedulerEntry sendAt(String name,
                           long milliseconds)
```
    Sends a new event to the Input Event Queue at a specified time.
    
    Parameters:
    
    name - event name.
    
    milliseconds - time in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAt
```
EventSchedulerEntry sendAt(String name,
                           long milliseconds,
                           long interval)
```
    Sends a new event to the Input Event Queue at a specified time and then periodically.
    
    Parameters:
    
    name - event name.
    
    milliseconds - time in milliseconds.
    
    interval - interval in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAt
```
EventSchedulerEntry sendAt(Event event,
                           long milliseconds)
```
    Sends an event to the Input Event Queue at a specified time.
    
    Parameters:
    
    event - event.
    
    milliseconds - time in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAt
```
EventSchedulerEntry sendAt(Event event,
                           long milliseconds,
                           long interval)
```
    Sends an event to the Input Event Queue at a specified time and then periodically.
    
    Parameters:
    
    event - event.
    
    milliseconds - time in milliseconds.
    
    interval - interval in milliseconds.
    
    Returns:
    
    scheduled event entry.
  - sendAt
```
EventSchedulerEntry sendAt(Event event,
                           String crontabSpec)
```
    Sends an event to the Input Event Queue at a time specified by the crontab spec.
    
    Parameters:
    
    event - event.
    
    crontabSpec - crontab spec.
    
    Returns:
    
    scheduled event entry.
  - sendAt
```
EventSchedulerEntry sendAt(String name,
                           String crontabSpec)
```
    Sends a new event to the Input Event Queue at a time specified by the crontab spec.
    
    Parameters:
    
    name - event name.
    
    crontabSpec - crontab spec.
    
    Returns:
    
    scheduled event entry.
  - removeEvent
```
boolean removeEvent(EventSchedulerEntry entry)
```
    Removes scheduled event.
    
    Parameters:
    
    entry - scheduled event entry.
    
    Returns:
    
    informs whether the specified event has been scheduled.
  - getPlugin
```
<T extends Plugin> T getPlugin(String name)
```
    Returns the plugin that has the specified name or null if there is no such plugin.
    
    Type Parameters:
    
    T - Plugin type.
    
    Parameters:
    
    name - plugin name.
    
    Returns:
    
    plugin.
  - getPlugin
```
<T extends Plugin> T getPlugin(String name,
                               Class<T> cls)
```
    Returns the plugin that has the specified name and type or null if there is no such plugin.
    
    Type Parameters:
    
    T - Plugin type.
    
    Parameters:
    
    name - plugin name.
    
    cls - plugin class.
    
    Returns:
    
    plugin.
  - getPlugin
```
<T extends Plugin> T getPlugin(Class<T> cls)
```
    Returns the plugin that has the specified type or null if there is no such plugin.
    
    Type Parameters:
    
    T - Plugin type.
    
    Parameters:
    
    cls - plugin class.
    
    Returns:
    
    plugin.
  - getVersion
```
String getVersion()
```
    Returns the engine version.
    
    Returns:
    
    the engine version.
  - getInfo
```
String getInfo()
```
    Returns the engine info.
    
    Returns:
    
    the engine info.
  - getStatisticsSummary
```
String getStatisticsSummary()
```
    Returns the engine statistics summary.
    
    Returns:
    
    the engine statistics summary.
  - makeEvent
```
Event makeEvent(String name)
```
    Creates a new named event with default clone policy.
    
    Parameters:
    
    name - event name.
    
    Returns:
    
    a new event.
  - makeEvent
```
Event makeEvent(String name,
                EventClonePolicy policy)
```
    Creates a new named event with specified clone policy.
    
    Parameters:
    
    name - event name.
    
    policy - event clone policy.
    
    Returns:
    
    a new event.
  - event
```
EventDefinition event(String name)
```
    Creates a new event definition.
    
    Parameters:
    
    name - event name.
    
    Returns:
    
    a new event definition.
  - event
```
EventDefinition event(String name,
                      EventClonePolicy policy)
```
    Creates a new event definition.
    
    Parameters:
    
    name - event name.
    
    policy - event clone policy.
    
    Returns:
    
    a new event definition.
  - event
```
EventDefinition event(Event event)
```
    Creates a new event definition.
    
    Parameters:
    
    event - an event.
    
    Returns:
    
    a new event definition.
  - existsAction
```
boolean existsAction(String name)
```
    Returns true if an action named name exists.
    
    Parameters:
    
    name - action name.
    
    Returns:
    
    true if an action named name exists.
  - existsFilter
```
boolean existsFilter(String name)
```
    Returns true if a filter named name exists.
    
    Parameters:
    
    name - filter name.
    
    Returns:
    
    true if a filter named name exists.
  - existsTrigger
```
boolean existsTrigger(String name)
```
    Returns true if a trigger named name exists.
    
    Parameters:
    
    name - trigger name.
    
    Returns:
    
    true if a trigger named name exists.
  - existsRule
```
boolean existsRule(String name)
```
    Returns true if a rule named name exists.
    
    Parameters:
    
    name - rule name.
    
    Returns:
    
    true if a rule named name exists.
  - existsCorrelator
```
boolean existsCorrelator(String name)
```
    Returns true if a correlator named name exists.
    
    Parameters:
    
    name - correlator name.
    
    Returns:
    
    true if a correlator named name exists.
  - setVariable
```
void setVariable(String name,
                 Object value)
```
    Sets the engine scope variable.
    
    Parameters:
    
    name - variable name.
    
    value - variable value.
  - getVariable
```
<T> T getVariable(String name)
```
    Returns the value of the engine scope variable. Throws exception if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    name - variable name.
    
    Returns:
    
    variable value.
  - getVariable
```
<T> T getVariable(Class<T> cls,
                  String name)
```
    Returns the value of the engine scope variable. Throws exception if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    cls - variable class.
    
    name - variable name.
    
    Returns:
    
    variable value.
  - getVariable
```
<T> T getVariable(String name,
                  T defaultValue)
```
    Returns the value of the engine scope variable or defaultValue if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    name - variable name.
    
    defaultValue - default value.
    
    Returns:
    
    variable value.
  - getVariable
```
<T> T getVariable(Class<T> cls,
                  String name,
                  T defaultValue)
```
    Returns the value of the engine scope variable or defaultValue if not found.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    cls - variable class.
    
    name - variable name.
    
    defaultValue - default value.
    
    Returns:
    
    variable value.
  - removeVariable
```
void removeVariable(String name)
```
    Removes the engine scope variable.
    
    Parameters:
    
    name - variable name.
  - existsVariable
```
boolean existsVariable(String name)
```
    Returns true if the engine scope variable named name exists.
    
    Parameters:
    
    name - variable name.
    
    Returns:
    
    true if the engine scope variable named name exists.
  - setVariableIfNone
```
<T> void setVariableIfNone(String name,
                           Supplier<T> supplier)
```
    Sets the engine scope variable if not set already.
    
    Type Parameters:
    
    T - variable.
    
    Parameters:
    
    name - variable name.
    
    supplier - variable value supplier.
  - updateVariable
```
void updateVariable(String name)
```
    Updates the engine scope variable.
    
    Parameters:
    
    name - variable name.

Interface EngineOperations

Method Summary

Method Detail

getEngine

call

call

shutdown

requestShutdown

reload

requestReload

send

send

sendAfter

sendAfter

sendAfter

sendAfter

sendAt

sendAt

sendAt

sendAt

sendAt

sendAt

removeEvent

getPlugin

getPlugin

getPlugin

getVersion

getInfo

getStatisticsSummary

makeEvent

makeEvent

event

event

event

existsAction

existsFilter

existsTrigger

existsRule

existsCorrelator

setVariable

getVariable

getVariable

getVariable

getVariable

removeVariable

existsVariable

setVariableIfNone

updateVariable