Checks that a game object does not set a custom type. More...

Inheritance diagram for net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	addIgnore (final int fromType, final int toType)
	Adds an allowed type change. More...

void	addIgnore (final int fromType, final int toType, final int envType)
	Adds an allowed type change. More...

	CustomTypeChecker (@NotNull final ValidatorPreferences validatorPreferences)
	Creates a new instance. More...

void	validateGameObject (@NotNull final G gameObject, @NotNull final ErrorCollector< G, A, R > errorCollector)
	Validates a game object. More...

Public Member Functions inherited from net.sf.gridarta.model.validation.AbstractValidator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >
String	getKey ()

boolean	isDefaultEnabled ()

boolean	isEnabled ()

void	setEnabled (final boolean enabled)

Public Member Functions inherited from net.sf.gridarta.model.validation.Validator< G, A, R >
String	getKey ()
	Get a Key that uniquely identifies this Validator. More...

boolean	isDefaultEnabled ()
	Get whether this Validator should be enabled per default. More...

boolean	isEnabled ()
	Get whether this Validator is enabled. More...

void	setEnabled (boolean enabled)
	Set whether this Validator should be enabled. More...

Private Member Functions
Map< Integer, Integer >	getIgnoreSet (final int type)
	Returns the allowed type changes for a given source type. More...

boolean	isAllowedTypeChange (@NotNull final GameObject< G, A, R > gameObject, final int archetypeTypeNo, final int gameObjectTypeNo)
	Returns whether the given game's changed type is allowed. More...

Private Attributes
final Map< Integer, Map< Integer, Integer > >	ignoreEntries = new HashMap<>()
	The allowed type changes. More...

Additional Inherited Members
Protected Member Functions inherited from net.sf.gridarta.model.validation.AbstractValidator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >
	AbstractValidator (@NotNull final ValidatorPreferences validatorPreferences) throws IllegalArgumentException
	Creates a new instance. More...

	AbstractValidator (@NotNull final ValidatorPreferences validatorPreferences, @NotNull final String key)
	Creates a new instance. More...

Detailed Description

Checks that a game object does not set a custom type.

Author: Andreas Kirschbaum

Definition at line 39 of file CustomTypeChecker.java.

Constructor & Destructor Documentation

◆ CustomTypeChecker()

net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.CustomTypeChecker ( @NotNull final ValidatorPreferences validatorPreferences )

Creates a new instance.

Parameters

validatorPreferences the validator preferences to use

Definition at line 53 of file CustomTypeChecker.java.

References net.sf.gridarta.model.validation.AbstractValidator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validatorPreferences.

Member Function Documentation

◆ addIgnore() [1/2]

void net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addIgnore	(	final int	fromType,
		final int	toType
	)

Adds an allowed type change.

Parameters

fromType	the allowed source type
toType	the allowed destination type

Definition at line 98 of file CustomTypeChecker.java.

References net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getIgnoreSet().

Referenced by net.sf.gridarta.model.validation.checks.ValidatorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newValidator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addIgnore() [2/2]

void net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addIgnore	(	final int	fromType,
		final int	toType,
		final int	envType
	)

Adds an allowed type change.

Parameters

fromType	the allowed source type
toType	the allowed destination type
envType	the type of the parent object

Definition at line 108 of file CustomTypeChecker.java.

References net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getIgnoreSet().

Here is the call graph for this function:

◆ getIgnoreSet()

Map<Integer, Integer> net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getIgnoreSet ( final int type )

private

Returns the allowed type changes for a given source type.

Parameters

type	the source type

Returns: the allowed type changes

Definition at line 118 of file CustomTypeChecker.java.

References net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ignoreEntries.

Referenced by net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addIgnore().

Here is the caller graph for this function:

◆ isAllowedTypeChange()

boolean net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isAllowedTypeChange	(	@NotNull final GameObject< G, A, R >	gameObject,
		final int	archetypeTypeNo,
		final int	gameObjectTypeNo
	)

private

Returns whether the given game's changed type is allowed.

Parameters

gameObject	the game object to check
archetypeTypeNo	the old type
gameObjectTypeNo	the new type

Returns: whether the type change is allowed

Definition at line 73 of file CustomTypeChecker.java.

References net.sf.gridarta.model.baseobject.BaseObject< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, T extends BaseObject< G, A, R, T >.getTypeNo(), and net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ignoreEntries.

Referenced by net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validateGameObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateGameObject()

void net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.validateGameObject	(	@NotNull final G	gameObject,
		@NotNull final ErrorCollector< G, A, R >	errorCollector
	)

Validates a game object.

Parameters

gameObject	the game object to validate
errorCollector	the error collector to report errors to

Implements net.sf.gridarta.model.validation.GameObjectValidator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.

Definition at line 58 of file CustomTypeChecker.java.

References net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isAllowedTypeChange().

Here is the call graph for this function:

Member Data Documentation

◆ ignoreEntries

final Map<Integer, Map<Integer, Integer> > net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ignoreEntries = new HashMap<>()

private

The allowed type changes.

Maps source type to destination type to environment type. The environment type may be

null

to denote "any environment".

Definition at line 47 of file CustomTypeChecker.java.

Referenced by net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getIgnoreSet(), and net.sf.gridarta.model.validation.checks.CustomTypeChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isAllowedTypeChange().

The documentation for this class was generated from the following file:

src/model/src/main/java/net/sf/gridarta/model/validation/checks/CustomTypeChecker.java

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CustomTypeChecker()

Member Function Documentation

◆ addIgnore() [1/2]

◆ addIgnore() [2/2]

◆ getIgnoreSet()

◆ isAllowedTypeChange()

◆ validateGameObject()

Member Data Documentation

◆ ignoreEntries