net.sf.gridarta.model.filter

Class AbstractFilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

java.lang.Object

net.sf.gridarta.model.filter.AbstractFilterConfig<F,C>

All Implemented Interfaces:

FilterConfig<F,C>

Direct Known Subclasses:

NamedFilterConfig, NamedGameObjectMatcherFilterConfig

public abstract class AbstractFilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>
extends java.lang.Object
implements FilterConfig<F,C>

Abstract base class for filter configurations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFilterConfig(F filter) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addConfigChangeListener(@NotNull FilterConfigListener listener) Adds a FilterConfigListener to be notified about changes.
protected void	fireEvent(@NotNull FilterConfigChangeType filterConfigChangeType, @NotNull FilterConfig<?,?> filterConfig) Notify all listeners that a FilterConfig has happened.
F	getFilter() Returns the Filter this filter config belongs to.
protected abstract C	getThis() Returns this filter config.
boolean	isEnabled() Returns whether the filter is enabled.
boolean	match(@NotNull GameObject<?,?,?> gameObject) Tells whether we got a match on specific GameObject.
void	removeConfigChangeListener(@NotNull 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.gridarta.model.filter.FilterConfig

accept

Constructor Detail

AbstractFilterConfig

protected AbstractFilterConfig(@NotNull
                               F filter)

Creates a new instance.

Parameters:

filter - the filter this filter config belongs to

Method Detail

getFilter

@NotNull
public F getFilter()

Description copied from interface: FilterConfig

Returns the Filter this filter config belongs to.

Specified by:

getFilter in interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Returns:

the filter

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: FilterConfig

Enables or disables the filter.

Specified by:

setEnabled in interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Parameters:

enabled - whether the filter should be enabled

isEnabled

public boolean isEnabled()

Description copied from interface: FilterConfig

Returns whether the filter is enabled.

Specified by:

isEnabled in interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Returns:

whether the filter is enabled

fireEvent

protected void fireEvent(@NotNull
                         @NotNull FilterConfigChangeType filterConfigChangeType,
                         @NotNull
                         @NotNull FilterConfig<?,?> filterConfig)

Notify all listeners that a FilterConfig has happened.

Parameters:

filterConfigChangeType - the config event type

filterConfig - the changed filter config

addConfigChangeListener

public void addConfigChangeListener(@NotNull
                                    @NotNull FilterConfigListener listener)

Description copied from interface: FilterConfig

Adds a FilterConfigListener to be notified about changes.

Specified by:

addConfigChangeListener in interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Parameters:

listener - the listener

removeConfigChangeListener

public void removeConfigChangeListener(@NotNull
                                       @NotNull FilterConfigListener listener)

Description copied from interface: FilterConfig

Removes a FilterConfigListener to be notified about changes.

Specified by:

removeConfigChangeListener in interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Parameters:

listener - the listener

match

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

Description copied from interface: FilterConfig

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.

Specified by:

match in interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Parameters:

gameObject - the game object being analyzed on the map

Returns:

whether it matches the criteria

reset

public boolean reset()

Description copied from interface: FilterConfig

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

Specified by:

reset in interface FilterConfig<F extends Filter<F,C>,C extends FilterConfig<F,C>>

Returns:

whether we had a global match on the map square

getThis

@NotNull
protected abstract C getThis()

Returns this filter config.

Returns:

this filter config