net.sf.gridarta.model.filter

Class NamedGameObjectMatcherFilter

java.lang.Object

net.sf.gridarta.model.filter.NamedGameObjectMatcherFilter

All Implemented Interfaces:

Filter<NamedGameObjectMatcherFilter,NamedGameObjectMatcherFilterConfig>

public class NamedGameObjectMatcherFilter
extends java.lang.Object
implements Filter<NamedGameObjectMatcherFilter,NamedGameObjectMatcherFilterConfig>

A Filter which filters according to a NamedGameObjectMatcher.

Constructor Summary

Constructors

Constructor and Description
NamedGameObjectMatcherFilter(@NotNull GameObjectMatcher matcher) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@NotNull NamedGameObjectMatcherFilterConfig	createConfig() Creates a new FilterConfig instance for this filter.
boolean	hasGlobalMatch(@NotNull NamedGameObjectMatcherFilterConfig config) Tells if all the game objects on a square are to be analyzed before a match result.
boolean	match(@NotNull NamedGameObjectMatcherFilterConfig config, @NotNull GameObject<?,?,?> gameObject) Tells whether we got a match on specific GameObject.
boolean	reset(@NotNull NamedGameObjectMatcherFilterConfig config) This tells the filter we have finished with current map square and, perhaps, we are jumping on next one.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedGameObjectMatcherFilter

public NamedGameObjectMatcherFilter(@NotNull
                                    @NotNull GameObjectMatcher matcher)

Creates a new instance.

Parameters:

matcher - the game object matcher to use

Method Detail

match

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

Description copied from interface: Filter

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. Unless Filter.hasGlobalMatch(FilterConfig) returns true, when a match occurred, this function is not called with the remaining game objects on the map square and a reset is issued.

Specified by:

match in interface Filter<NamedGameObjectMatcherFilter,NamedGameObjectMatcherFilterConfig>

Parameters:

config - the filter configuration to use

gameObject - the game object being analyzed on the map

Returns:

whether it matches the criteria; this value is ignored if hasGlobalMatch() returns true

reset

public boolean reset(@NotNull
                     @NotNull NamedGameObjectMatcherFilterConfig config)

Description copied from interface: Filter

This tells the filter we have finished with current map square and, perhaps, we are jumping on next one. If Filter.hasGlobalMatch(FilterConfig) returns true, the returning value is used to know if we had a match.

Specified by:

reset in interface Filter<NamedGameObjectMatcherFilter,NamedGameObjectMatcherFilterConfig>

Parameters:

config - the filter configuration to use

Returns:

whether we had a global match on map square

hasGlobalMatch

public boolean hasGlobalMatch(@NotNull
                              @NotNull NamedGameObjectMatcherFilterConfig config)

Description copied from interface: Filter

Tells if all the game objects on a square are to be analyzed before a match result. If all game objects must be analyzed to decide the result of a match, the return value of Filter.match(FilterConfig, GameObject) is ignored and the returning value of Filter.reset(FilterConfig) is used as replacement. This should mainly used by complex analyze filters.

Specified by:

hasGlobalMatch in interface Filter<NamedGameObjectMatcherFilter,NamedGameObjectMatcherFilterConfig>

Parameters:

config - the filter configuration to use

Returns:

whether a match can be decided only when all game objects on a map square are analyzed

createConfig

@NotNull
public @NotNull NamedGameObjectMatcherFilterConfig createConfig()

Description copied from interface: Filter

Creates a new FilterConfig instance for this filter.

Specified by:

createConfig in interface Filter<NamedGameObjectMatcherFilter,NamedGameObjectMatcherFilterConfig>

Returns:

the new filter config instance