com.fluxtion.api.annotations

Annotation Type EventHandler

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface EventHandler

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	filterId The filter value as an int, a value of Integer.MAX_VALUE indicates no filtering should be applied.
String	filterString The filter value as a String, a zero length String indicates no filtering should be applied.
Class	filterStringFromClass The filter value as a String derived from the supplied class.
String	filterVariable A member of this class that provides a value to override static values in annotation.
boolean	propagate Determines whether the SEP will invoke dependents as part of the event call chain.
FilterType	value the type of match against the filter this event handler will perform A matched will filter will only process events that match the associated filter Id, this is the default behaviour of the EventHandler.

Element Detail

value

public abstract FilterType value

the type of match against the filter this event handler will perform A matched will filter will only process events that match the associated filter Id, this is the default behaviour of the EventHandler. If no filter is supplied then the EventHandler matches against all filters, and will be notified of any incoming event. If filterType is set to unmatched then the handler will be notified if there are no filters in the system that match against the event, this is the same behaviour as the default in a case statement if each matching case calls break.

Returns:

FilterType matching strategy

Default:

com.fluxtion.api.annotations.FilterType.matched

filterId

public abstract int filterId

The filter value as an int, a value of Integer.MAX_VALUE indicates no filtering should be applied.

Returns:

the filter value of the handler to match against filterId of event

Default:

2147483647

filterString

public abstract String filterString

The filter value as a String, a zero length String indicates no filtering should be applied.

Returns:

the filter value of the handler to match against filterString of event

Default:

""

filterVariable

public abstract String filterVariable

A member of this class that provides a value to override static values in annotation.

Returns:

FIled providing filter override

Default:

""

filterStringFromClass

public abstract Class filterStringFromClass

The filter value as a String derived from the supplied class. The value is the fully qualified name of the class, a void.class indicates no filtering should be applied. All '.' separators are replaced with '_'

Returns:

the filter value of the handler to match against filterString of event

Default:

void.class

propagate

public abstract boolean propagate

Determines whether the SEP will invoke dependents as part of the event call chain.

Returns:

invoke dependents on update

Default:

true