net.sf.gridarta.model.validation

Class AbstractValidator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.model.validation.AbstractValidator<G,A,R>

All Implemented Interfaces:

Validator<G,A,R>

Direct Known Subclasses:

AbstractShopSquareChecker, AttributeRangeChecker, BlockedMobOrSpawnPointChecker, BlockedSpawnPointChecker, BlockedSquareChecker, ConnectedInsideContainerChecker, ConnectedPickableChecker, ConnectionChecker, CustomTypeChecker, DelegatingMapValidator, DoubleLayerChecker, DoubleTypeChecker, DuplicateMonsterOnSquareChecker, EmptySpawnPointChecker, EnvironmentChecker, ExitChecker, MapCheckerScriptChecker, MapDifficultyChecker, MapEnterLocationChecker, MobOutsideSpawnPointChecker, NonAbsoluteExitPathChecker, SlayingChecker, SquareWithoutFloorChecker, SuspiciousMsgChecker, SysObjectNotOnLayerZeroChecker, TilePathsChecker, UndefinedArchetypeChecker, UndefinedFaceChecker, UnsetSlayingChecker

public abstract class AbstractValidator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements Validator<G,A,R>

This is the base class for validators.

Note:

that this class completely implements the interface Validator but does not declare it to force subclasses to choose the interface to implement.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractValidator(@NotNull ValidatorPreferences validatorPreferences) Creates a new instance.
protected	AbstractValidator(@NotNull ValidatorPreferences validatorPreferences, @NotNull java.lang.String key) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getKey() Get a Key that uniquely identifies this Validator.
boolean	isDefaultEnabled() Get whether this Validator should be enabled per default.
boolean	isEnabled() Get whether this Validator is enabled.
void	setEnabled(boolean enabled) Set whether this Validator should be enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValidator

protected AbstractValidator(@NotNull
                            @NotNull ValidatorPreferences validatorPreferences)
                     throws java.lang.IllegalArgumentException

Creates a new instance. The key is generated from the validator's name, which must end on "Checker".

Parameters:

validatorPreferences - the validator preferences to use

Throws:

java.lang.IllegalArgumentException - in case the validator's name does not end on "Checker".

AbstractValidator

protected AbstractValidator(@NotNull
                            @NotNull ValidatorPreferences validatorPreferences,
                            @NotNull
                            @NotNull java.lang.String key)

Creates a new instance.

Parameters:

validatorPreferences - the validator preferences to use

key - Key

Method Detail

getKey

@NotNull
public @NotNull java.lang.String getKey()

Description copied from interface: Validator

Get a Key that uniquely identifies this Validator. The key can then be used for purposes like i18n/l10n or preferences.

Specified by:

getKey in interface Validator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

key

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Validator

Set whether this Validator should be enabled.

Specified by:

setEnabled in interface Validator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

enabled - true if this validator should be enabled, otherwise false

isEnabled

public boolean isEnabled()

Description copied from interface: Validator

Get whether this Validator is enabled.

Specified by:

isEnabled in interface Validator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

enabled

isDefaultEnabled

public boolean isDefaultEnabled()

Description copied from interface: Validator

Get whether this Validator should be enabled per default.

Specified by:

isDefaultEnabled in interface Validator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

defaultEnabled