com.fluxtion.builder.annotation

Annotation Type SepInstance

@Target(value=TYPE)
 @Retention(value=CLASS)
 @Documented
public @interface SepInstance

Mark a class as an instance encapsulated by a SEP, this can be used in place of a builder method when the SEP contains only one imperatively added node. The encapsulated instance is scoped as a public final declared variable with the name "processor" .

Generation for this classes can be disabled by adding the Disabled annotation the class.

Author:

V12 Technology Ltd.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the generated EventHandler
String	packageName the name of the package the generated artifacts will be written to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	cleanOutputDir USE WITH CARE
boolean	initialise call the lifecycle initialise method on the generated SEP
String	outputDir Output directory for Fluxtion generated source artifacts.
String	resourceDir Output directory for generated meta-data describing the static event processor typical.
boolean	supportDirtyFiltering Configures generated code to support dirty filtering

Element Detail

packageName

public abstract String packageName

the name of the package the generated artifacts will be written to.

Returns:

package name

name

public abstract String name

The name of the generated EventHandler

Returns:

event handler name

outputDir

public abstract String outputDir

Output directory for Fluxtion generated source artifacts. The default directory is supplied in the generation process, setting this value overrides the default. Using maven the typical values are:

• target/generated-sources/fluxtion
• target/generated-test-sources/fluxtion
• src/main/java

Returns:

overridden output directory

Default:

""

resourceDir

public abstract String resourceDir

Output directory for generated meta-data describing the static event processor typical. The default directory is supplied in the generation process, setting this value overrides the default. Using maven typical values are:

• src/main/resources
• src/test/resources

Returns:

overridden resource directory

Default:

""

cleanOutputDir

public abstract boolean cleanOutputDir

USE WITH CARE

Cleans output directory of all files before generating artefacts. if two annotations are configured in the same build with the same output directory, setting this option to true will have unpredictable results.

Returns:

flag to control cleaning of output directory

Default:

false

supportDirtyFiltering

public abstract boolean supportDirtyFiltering

Configures generated code to support dirty filtering

Returns:

flag to control generation conditional branching

Default:

true

initialise

public abstract boolean initialise

call the lifecycle initialise method on the generated SEP

Returns:

Default:

true