com.fluxtion.compiler.builder.filter

Class FilterDescription

java.lang.Object

com.fluxtion.compiler.builder.filter.FilterDescription

public class FilterDescription
extends Object

Customises the generated source files to provide user controlled FilterDescription's. A user can provide logic to control comment and variable names for filters in the generated code. The intention is to make the generated SEP easier to understand reducing cost to rectify errors.

FilterDescriptionProducer are registered as producers of descriptions.

Author:

Greg Higgins

Field Summary

Fields

Modifier and Type	Field and Description
String	comment Human readable comment to be associated with this filter in the generated code of the SEP.
static FilterDescription	DEFAULT_FILTER
Class<? extends com.fluxtion.runtime.event.Event>	eventClass the event class for this filter.
static FilterDescription	INVERSE_FILTER
boolean	isFiltered Indicates presence of filtering, false value means match all values.
boolean	isIntFilter boolean value indicating String or integer based filtering.
static FilterDescription	NO_FILTER
String	stringValue Value used by the SEP to determine which decision branch to navigate.
int	value Value used by the SEP to determine which decision branch to navigate.
String	variableName User suggested identifier for this filter in the generated SEP code.

Constructor Summary

Constructors

Constructor and Description
FilterDescription(Class<? extends com.fluxtion.runtime.event.Event> eventClass)
FilterDescription(Class<? extends com.fluxtion.runtime.event.Event> eventClass, int value)
FilterDescription(Class<? extends com.fluxtion.runtime.event.Event> eventClass, String value)

Method Summary

Modifier and Type	Method and Description
static FilterDescription	build(Object input)
FilterDescription	changeClass(Class<? extends com.fluxtion.runtime.event.Event> newClass)
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_FILTER

public static final FilterDescription NO_FILTER

INVERSE_FILTER

public static final FilterDescription INVERSE_FILTER

DEFAULT_FILTER

public static final FilterDescription DEFAULT_FILTER

value

public final int value

Value used by the SEP to determine which decision branch to navigate. If integer filtering is used.

stringValue

public final String stringValue

Value used by the SEP to determine which decision branch to navigate. If String filtering is used

isIntFilter

public final boolean isIntFilter

boolean value indicating String or integer based filtering.

isFiltered

public boolean isFiltered

Indicates presence of filtering, false value means match all values.

eventClass

public Class<? extends com.fluxtion.runtime.event.Event> eventClass

the event class for this filter.

comment

public String comment

Human readable comment to be associated with this filter in the generated code of the SEP. Depending upon the target language this value may be mutated to suit the target language rules.

variableName

public String variableName

User suggested identifier for this filter in the generated SEP code. Depending upon the target language this value may be mutated to suit the relevant rules.

Constructor Detail

FilterDescription

public FilterDescription(Class<? extends com.fluxtion.runtime.event.Event> eventClass)

FilterDescription

public FilterDescription(Class<? extends com.fluxtion.runtime.event.Event> eventClass,
                         int value)

FilterDescription

public FilterDescription(Class<? extends com.fluxtion.runtime.event.Event> eventClass,
                         String value)

Method Detail

build

public static FilterDescription build(Object input)

changeClass

public FilterDescription changeClass(Class<? extends com.fluxtion.runtime.event.Event> newClass)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object