EngineBuilder (Sponge - Core 1.18.0 API)

java.lang.Object
- org.openksavi.sponge.core.engine.EngineBuilder<T>

public class EngineBuilder<T extends BaseSpongeEngine>
extends Object

Engine builder. It provides the most common settings for the engine.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AtomicReference<List<KnowledgeBase>>`	`additionalKnowledgeBases` Additional knowledge bases list reference - pre or post config.
`protected AtomicReference<List<Plugin>>`	`additionalPlugins` Additional plugins list reference - pre or post config.
`protected T`	`engine` The engine.
`protected Boolean`	`ignoreConfigurationFileNotFound`
`protected List<KnowledgeBase>`	`postConfigKnowledgeBases` Knowledge bases added manually after the config file.
`protected List<Plugin>`	`postConfigPlugins` Plugins added manually after the config file.
`protected List<KnowledgeBase>`	`preConfigKnowledgeBases` Knowledge bases added manually before the config file.
`protected List<Plugin>`	`preConfigPlugins` Plugins added manually before the config file.
`protected Map<String,PropertyEntry>`	`propertyEntries` Properties.

Constructor Summary

Constructors
Constructor and Description

EngineBuilder(T engine)
Creates a new Engine Builder.

Constructors
Constructor and Description
`EngineBuilder(T engine)` Creates a new Engine Builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`build()` Build the engine.
`EngineBuilder<T>`	`config(String configFilename)` Sets the configuration filename.
`EngineBuilder<T>`	`defaultKnowledgeBaseName(String defaultKnowledgeBaseName)` Sets the default knowledge base name.
`EngineBuilder<T>`	`description(String description)` Sets the engine description.
`EngineBuilder<T>`	`eventQueueProvider(EventQueueProvider eventQueueProvider)` Sets the event queue provider.
`EngineBuilder<T>`	`exceptionHandler(ExceptionHandler exceptionHandler)` Sets the exception handler.
`EngineParameters`	`getEngineDefaultParameters()` Returns the engine default parameters.
`String`	`getInfo()` Returns the engine info.
`EngineBuilder<T>`	`ignoreConfigurationFileNotFound(Boolean ignoreConfigurationFileNotFound)`
`EngineBuilder<T>`	`init()`
`EngineBuilder<T>`	`knowledgeBase(KnowledgeBase knowledgeBase)` Adds the knowledge base.
`EngineBuilder<T>`	`knowledgeBase(String name, KnowledgeBaseScript... scripts)` Adds the knowledge base.
`EngineBuilder<T>`	`knowledgeBase(String name, KnowledgeBaseType type, KnowledgeBaseScript... scripts)` Adds the knowledge base.
`EngineBuilder<T>`	`knowledgeBase(String name, KnowledgeBaseType type, List<KnowledgeBaseScript> scripts)` Adds the knowledge base.
`EngineBuilder<T>`	`knowledgeBase(String name, KnowledgeBaseType type, String... files)` Adds the knowledge base.
`EngineBuilder<T>`	`knowledgeBase(String name, List<KnowledgeBaseScript> scripts)` Adds the knowledge base.
`EngineBuilder<T>`	`knowledgeBase(String name, String... files)` Adds the knowledge base.
`EngineBuilder<T>`	`knowledgeBaseFileProvider(KnowledgeBaseFileProvider knowledgeBaseFileProvider)` Sets the knowledge base file provider.
`EngineBuilder<T>`	`knowledgeBaseInterpreterFactoryProviders(List<KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)` Sets the knowledge base interpreter factory providers.
`EngineBuilder<T>`	`knowledgeBaseString(String name, KnowledgeBaseType type, String body)` Adds the String-based knowledge base.
`EngineBuilder<T>`	`label(String label)` Sets the engine label.
`EngineBuilder<T>`	`license(String license)` Sets the engine license.
`EngineBuilder<T>`	`moduleProvider(EngineModuleProvider moduleProvider)` Sets the module provider.
`EngineBuilder<T>`	`name(String name)` Sets the engine name.
`EngineBuilder<T>`	`plugin(Plugin plugin)` Adds the plugin.
`EngineBuilder<T>`	`plugins(Plugin... plugins)` Adds the plugins.
`EngineBuilder<T>`	`processingUnitProvider(ProcessingUnitProvider processingUnitProvider)` Sets the processing unit provider.
`EngineBuilder<T>`	`properties(Map<String,Object> simpleProperties)` Sets the properties.
`EngineBuilder<T>`	`property(String name, Object value)` Sets the property (that is neither a variable nor a system property).
`EngineBuilder<T>`	`property(String name, Object value, boolean variable, boolean system)` Sets the property.
`EngineBuilder<T>`	`systemProperties(Map<String,String> systemProperties)` Sets the system properties.
`EngineBuilder<T>`	`systemProperty(String name, Object value)` Sets the system property (that is not a variable).
`EngineBuilder<T>`	`variableProperties(Map<String,String> variableProperties)` Sets the variable properties.
`EngineBuilder<T>`	`variableProperty(String name, Object value)` Sets the property that is also a variable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - engine
```
protected T extends BaseSpongeEngine engine
```
    The engine.
  - preConfigPlugins
```
protected List<Plugin> preConfigPlugins
```
    Plugins added manually before the config file.
  - postConfigPlugins
```
protected List<Plugin> postConfigPlugins
```
    Plugins added manually after the config file.
  - additionalPlugins
```
protected AtomicReference<List<Plugin>> additionalPlugins
```
    Additional plugins list reference - pre or post config.
  - preConfigKnowledgeBases
```
protected List<KnowledgeBase> preConfigKnowledgeBases
```
    Knowledge bases added manually before the config file.
  - postConfigKnowledgeBases
```
protected List<KnowledgeBase> postConfigKnowledgeBases
```
    Knowledge bases added manually after the config file.
  - additionalKnowledgeBases
```
protected AtomicReference<List<KnowledgeBase>> additionalKnowledgeBases
```
    Additional knowledge bases list reference - pre or post config.
  - propertyEntries
```
protected Map<String,PropertyEntry> propertyEntries
```
    Properties.
  - ignoreConfigurationFileNotFound
```
protected Boolean ignoreConfigurationFileNotFound
```
- Constructor Detail
  - EngineBuilder
```
public EngineBuilder(T engine)
```
    Creates a new Engine Builder.
    
    Parameters:
    
    engine - the engine.
- Method Detail
  - name
```
public EngineBuilder<T> name(String name)
```
    Sets the engine name.
    
    Parameters:
    
    name - the engine name.
    
    Returns:
    
    this builder.
  - label
```
public EngineBuilder<T> label(String label)
```
    Sets the engine label.
    
    Parameters:
    
    label - the engine label.
    
    Returns:
    
    this builder.
  - description
```
public EngineBuilder<T> description(String description)
```
    Sets the engine description.
    
    Parameters:
    
    description - the engine description.
    
    Returns:
    
    this builder.
  - license
```
public EngineBuilder<T> license(String license)
```
    Sets the engine license.
    
    Parameters:
    
    license - the engine license.
    
    Returns:
    
    this builder.
  - moduleProvider
```
public EngineBuilder<T> moduleProvider(EngineModuleProvider moduleProvider)
```
    Sets the module provider.
    
    Parameters:
    
    moduleProvider - the moduleProvider to set.
    
    Returns:
    
    this builder.
  - knowledgeBaseInterpreterFactoryProviders
```
public EngineBuilder<T> knowledgeBaseInterpreterFactoryProviders(List<KnowledgeBaseInterpreterFactoryProvider> knowledgeBaseInterpreterFactoryProviders)
```
    Sets the knowledge base interpreter factory providers.
    
    Parameters:
    
    knowledgeBaseInterpreterFactoryProviders - the knowledge base interpreter factory providers.
    
    Returns:
    
    this builder.
  - eventQueueProvider
```
public EngineBuilder<T> eventQueueProvider(EventQueueProvider eventQueueProvider)
```
    Sets the event queue provider.
    
    Parameters:
    
    eventQueueProvider - the event queue provider.
    
    Returns:
    
    this builder.
  - processingUnitProvider
```
public EngineBuilder<T> processingUnitProvider(ProcessingUnitProvider processingUnitProvider)
```
    Sets the processing unit provider.
    
    Parameters:
    
    processingUnitProvider - the processing unit provider.
    
    Returns:
    
    this builder.
  - knowledgeBaseFileProvider
```
public EngineBuilder<T> knowledgeBaseFileProvider(KnowledgeBaseFileProvider knowledgeBaseFileProvider)
```
    Sets the knowledge base file provider.
    
    Parameters:
    
    knowledgeBaseFileProvider - the knowledge base file provider.
    
    Returns:
    
    this builder.
  - config
```
public EngineBuilder<T> config(String configFilename)
```
    Sets the configuration filename.
    
    Parameters:
    
    configFilename - the configuration filename.
    
    Returns:
    
    this builder.
  - property
```
public EngineBuilder<T> property(String name,
                                 Object value,
                                 boolean variable,
                                 boolean system)
```
    Sets the property.
    
    Parameters:
    
    name - the property name.
    
    value - the property value.
    
    variable - should the property be used as a variable.
    
    system - is the property a system property.
    
    Returns:
    
    this builder.
  - property
```
public EngineBuilder<T> property(String name,
                                 Object value)
```
    Sets the property (that is neither a variable nor a system property).
    
    Parameters:
    
    name - the property name.
    
    value - the property value.
    
    Returns:
    
    this builder.
  - systemProperty
```
public EngineBuilder<T> systemProperty(String name,
                                       Object value)
```
    Sets the system property (that is not a variable).
    
    Parameters:
    
    name - the property name.
    
    value - the property value.
    
    Returns:
    
    this builder.
  - variableProperty
```
public EngineBuilder<T> variableProperty(String name,
                                         Object value)
```
    Sets the property that is also a variable.
    
    Parameters:
    
    name - the property name.
    
    value - the property value.
    
    Returns:
    
    this builder.
  - properties
```
public EngineBuilder<T> properties(Map<String,Object> simpleProperties)
```
    Sets the properties.
    
    Parameters:
    
    simpleProperties - the properties.
    
    Returns:
    
    this builder.
  - systemProperties
```
public EngineBuilder<T> systemProperties(Map<String,String> systemProperties)
```
    Sets the system properties.
    
    Parameters:
    
    systemProperties - the system properties.
    
    Returns:
    
    this builder.
  - variableProperties
```
public EngineBuilder<T> variableProperties(Map<String,String> variableProperties)
```
    Sets the variable properties.
    
    Parameters:
    
    variableProperties - the variable properties.
    
    Returns:
    
    this builder.
  - plugin
```
public EngineBuilder<T> plugin(Plugin plugin)
```
    Adds the plugin.
    
    Parameters:
    
    plugin - the plugin.
    
    Returns:
    
    this builder.
  - plugins
```
public EngineBuilder<T> plugins(Plugin... plugins)
```
    Adds the plugins.
    
    Parameters:
    
    plugins - the plugins.
    
    Returns:
    
    this builder.
  - knowledgeBase
```
public EngineBuilder<T> knowledgeBase(KnowledgeBase knowledgeBase)
```
    Adds the knowledge base.
    
    Parameters:
    
    knowledgeBase - the knowledge base.
    
    Returns:
    
    this builder.
  - knowledgeBase
```
public EngineBuilder<T> knowledgeBase(String name,
                                      KnowledgeBaseType type,
                                      String... files)
```
    Adds the knowledge base.
    
    Parameters:
    
    name - the knowledge base name.
    
    type - the knowledge base type.
    
    files - the knowledge base files.
    
    Returns:
    
    this builder.
  - knowledgeBase
```
public EngineBuilder<T> knowledgeBase(String name,
                                      String... files)
```
    Adds the knowledge base.
    
    Parameters:
    
    name - the knowledge base name.
    
    files - the knowledge base files.
    
    Returns:
    
    this builder.
  - knowledgeBase
```
public EngineBuilder<T> knowledgeBase(String name,
                                      KnowledgeBaseScript... scripts)
```
    Adds the knowledge base.
    
    Parameters:
    
    name - the knowledge base name.
    
    scripts - the knowledge base scripts.
    
    Returns:
    
    this builder.
  - knowledgeBase
```
public EngineBuilder<T> knowledgeBase(String name,
                                      KnowledgeBaseType type,
                                      KnowledgeBaseScript... scripts)
```
    Adds the knowledge base.
    
    Parameters:
    
    name - the knowledge base name.
    
    type - the knowledge base type.
    
    scripts - the knowledge base scripts.
    
    Returns:
    
    this builder.
  - knowledgeBase
```
public EngineBuilder<T> knowledgeBase(String name,
                                      List<KnowledgeBaseScript> scripts)
```
    Adds the knowledge base.
    
    Parameters:
    
    name - the knowledge base name.
    
    scripts - the knowledge base scripts.
    
    Returns:
    
    this builder.
  - knowledgeBase
```
public EngineBuilder<T> knowledgeBase(String name,
                                      KnowledgeBaseType type,
                                      List<KnowledgeBaseScript> scripts)
```
    Adds the knowledge base.
    
    Parameters:
    
    name - the knowledge base name.
    
    type - the knowledge base type.
    
    scripts - the knowledge base scripts.
    
    Returns:
    
    this builder.
  - knowledgeBaseString
```
public EngineBuilder<T> knowledgeBaseString(String name,
                                            KnowledgeBaseType type,
                                            String body)
```
    Adds the String-based knowledge base.
    
    Parameters:
    
    name - the knowledge base name.
    
    type - the knowledge base type.
    
    body - the String-based knowledge base body.
    
    Returns:
    
    this builder.
  - exceptionHandler
```
public EngineBuilder<T> exceptionHandler(ExceptionHandler exceptionHandler)
```
    Sets the exception handler.
    
    Parameters:
    
    exceptionHandler - the new exception handler.
    
    Returns:
    
    this builder.
  - defaultKnowledgeBaseName
```
public EngineBuilder<T> defaultKnowledgeBaseName(String defaultKnowledgeBaseName)
```
    Sets the default knowledge base name.
    
    Parameters:
    
    defaultKnowledgeBaseName - the default knowledge base name.
    
    Returns:
    
    this builder.
  - ignoreConfigurationFileNotFound
```
public EngineBuilder<T> ignoreConfigurationFileNotFound(Boolean ignoreConfigurationFileNotFound)
```
  - getEngineDefaultParameters
```
public EngineParameters getEngineDefaultParameters()
```
    Returns the engine default parameters. This method allows changing the values of default parameters.
    
    Returns:
    
    the engine default parameters
  - init
```
public EngineBuilder<T> init()
```
  - build
```
public T build()
```
    Build the engine.
    
    Returns:
    
    the engine.
  - getInfo
```
public String getInfo()
```
    Returns the engine info.
    
    Returns:
    
    the engine info.

Class EngineBuilder<T extends BaseSpongeEngine>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

engine

preConfigPlugins

postConfigPlugins

additionalPlugins

preConfigKnowledgeBases

postConfigKnowledgeBases

additionalKnowledgeBases

propertyEntries

ignoreConfigurationFileNotFound

Constructor Detail

EngineBuilder

Method Detail

name

label

description

license

moduleProvider

knowledgeBaseInterpreterFactoryProviders

eventQueueProvider

processingUnitProvider

knowledgeBaseFileProvider

config

property

property

systemProperty

variableProperty

properties

systemProperties

variableProperties

plugin

plugins

knowledgeBase

knowledgeBase

knowledgeBase

knowledgeBase

knowledgeBase

knowledgeBase

knowledgeBase

knowledgeBaseString

exceptionHandler

defaultKnowledgeBaseName

ignoreConfigurationFileNotFound

getEngineDefaultParameters

init

build

getInfo