net.sf.gridarta.model.filter

Interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

All Known Implementing Classes:

AbstractFilterConfig, NamedFilterConfig, NamedGameObjectMatcherFilterConfig

public interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Interface for filter configurations.

Method Summary

Modifier and Type	Method and Description
void	accept(@NotNull FilterConfigVisitor visitor) Visits the appropriate visit() function of a FilterConfigVisitor.
void	addConfigChangeListener(FilterConfigListener listener) Adds a FilterConfigListener to be notified about changes.
F	getFilter() Returns the Filter this filter config belongs to.
boolean	isEnabled() Returns whether the filter is enabled.
boolean	match(@NotNull GameObject<?,?,?> gameObject) Tells whether we got a match on specific GameObject.
void	removeConfigChangeListener(FilterConfigListener listener) Removes a FilterConfigListener to be notified about changes.
boolean	reset() Tells the filter we have finished with current map square and, perhaps, we are jumping on next one.
void	setEnabled(boolean enabled) Enables or disables the filter.

Method Detail

getFilter

@NotNull
F getFilter()

Returns the Filter this filter config belongs to.

Returns:

the filter

setEnabled

void setEnabled(boolean enabled)

Enables or disables the filter.

Parameters:

enabled - whether the filter should be enabled

isEnabled

boolean isEnabled()

Returns whether the filter is enabled.

Returns:

whether the filter is enabled

addConfigChangeListener

void addConfigChangeListener(FilterConfigListener listener)

Adds a FilterConfigListener to be notified about changes.

Parameters:

listener - the listener

removeConfigChangeListener

void removeConfigChangeListener(FilterConfigListener listener)

Removes a FilterConfigListener to be notified about changes.

Parameters:

listener - the listener

accept

void accept(@NotNull
            @NotNull FilterConfigVisitor visitor)

Visits the appropriate visit() function of a FilterConfigVisitor.

Parameters:

visitor - the visitor to call

match

boolean match(@NotNull
              @NotNull GameObject<?,?,?> gameObject)

Tells whether we got a match on specific GameObject. The analysis tool will call this function with every game object on a given map square. The match function is responsible for analyzing inventories if it needs to.

Parameters:

gameObject - the game object being analyzed on the map

Returns:

whether it matches the criteria

reset

boolean reset()

Tells the filter we have finished with current map square and, perhaps, we are jumping on next one.

Returns:

whether we had a global match on the map square