com.fluxtion.builder.annotation

Annotation Type SepBuilder

@Target(value=METHOD)
 @Retention(value=CLASS)
 @Documented
public @interface SepBuilder

Mark a method as a SEP builder. The method must accept one argument of type SEPConfig. The receiving method will use the provided SEPConfig instance to define the static event processor that Fluxtion will generate.

Individual methods or whole classes can be disabled by adding the Disabled annotation to either a method or class respectively.

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.

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

default value = src/main/java

Returns:

overridden output directory

Default:

"src/main/java"

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 clean the output directory specified in outputDir()

Default:

true

initialise

public abstract boolean initialise

call the lifecycle initialise method on the generated SEP

Returns:

flag to call initialise in generated event processor

Default:

true