org.tools4j.elara.plugin.base

Enum BasePlugin

java.lang.Object

java.lang.Enum<BasePlugin>

org.tools4j.elara.plugin.base.BasePlugin

All Implemented Interfaces:

Serializable, Comparable<BasePlugin>, Plugin<BaseState.Mutable>, SystemPlugin<BaseState.Mutable>

public enum BasePlugin
extends Enum<BasePlugin>
implements SystemPlugin<BaseState.Mutable>

Default plugin to initialise BaseState. Another plugin can be used to initialise the base state if it returns an implementation of BasePlugin.BaseConfiguration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BasePlugin.BaseConfiguration Base context to initialise base state.

Nested classes/interfaces inherited from interface org.tools4j.elara.plugin.api.Plugin

Plugin.Configuration, Plugin.Dependency<P>, Plugin.NullState

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields inherited from interface org.tools4j.elara.plugin.api.Plugin

NO_DEPENDENCIES, NO_INPUTS, STATE_UNAWARE

Method Summary

Modifier and Type	Method and Description
BasePlugin.BaseConfiguration	configuration(Configuration appConfig, BaseState.Mutable baseState)
BaseState.Mutable	defaultPluginState()
TypeRange	typeRange()
static BasePlugin	valueOf(String name) Returns the enum constant of this type with the specified name.
static BasePlugin[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tools4j.elara.plugin.api.Plugin

dependencies

Enum Constant Detail

INSTANCE

public static final BasePlugin INSTANCE

Method Detail

values

public static BasePlugin[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BasePlugin c : BasePlugin.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BasePlugin valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

defaultPluginState

public BaseState.Mutable defaultPluginState()

Specified by:

defaultPluginState in interface Plugin<BaseState.Mutable>

configuration

public BasePlugin.BaseConfiguration configuration(Configuration appConfig,
                                                  BaseState.Mutable baseState)

Specified by:

configuration in interface Plugin<BaseState.Mutable>

typeRange

public TypeRange typeRange()

Specified by:

typeRange in interface SystemPlugin<BaseState.Mutable>