Package net.sf.gridarta.model.validation.checks

This package contains the checks for validating maps. More...

Classes
class	AbstractShopSquareChecker
	A MapValidator to detect shop squares which allow magic or prayers, or which have adjacent squares that allow magic or prayers. More...
class	ArchetypeTypeChecks
	Creates checks from ArchetypeTypes. More...
class	AttributeRangeChecker
	A validator that checks for suspicious attribute values. More...
class	BlockedMatrix
	Determines whether a map square is blocked. More...
class	BlockedMobOrSpawnPointChecker
	A SquareValidator to assert that mobs or spawn points aren't on blocked squares. More...
class	BlockedSpawnPointChecker
	A MapValidator to assert that mobs or spawn points aren't on blocked squares. More...
class	BlockedSquareChecker
	A MapValidator to assert that a square that's blocked and no_pass is not surrounded by blocked and no_pass only. More...
class	ConnectedInsideContainerChecker
	An GameObjectValidator to assert that containers do not contain connected objects. More...
class	ConnectedPickableChecker
	A Validator to assert that connected objects cannot be picked up. More...
class	ConnectionChecker
	Checks that for each connection value at least one source and at least one sink exists. More...
class	CustomTypeChecker
	Checks that a game object does not set a custom type. More...
class	DoubleLayerChecker
	A SquareValidator to assert that there are no two objects within the same layer. More...
class	DoubleTypeChecker
	A SquareValidator to assert that there are no two arches of the same type on the same square. More...
class	EmptySpawnPointChecker
	An GameObjectValidator to assert that spawn points are not empty. More...
class	Entry
	An entry to match consisting of a GameObjectMatcher and a regular expression which defined the allowed value of the "slaying" field. More...
class	EnvironmentChecker
	A GameObjectValidator that checks for valid environment. More...
class	ExitChecker
	A Validator to assert that exits are connected to maps properly. More...
class	InvalidCheckException
	An Exception indicating that an attribute check is invalid. More...
class	MapCheckerScriptChecker
	Executes a script to check a map. More...
class	MapCheckerScriptFailureError
	A MapValidationError that indicates that the map validator script could not be executed. More...
class	MapCheckerScriptIOError
	A ValidationError that reports I/O errors related to MapCheckerScriptChecker. More...
class	MapCheckerScriptMapError
	A MapValidationError that represents a per map error of the MapCheckerScriptChecker. More...
class	MapCheckerScriptMapSquareError
	A SquareValidationError that represents a per map square error of the MapCheckerScriptChecker. More...
class	MapCheckerScriptMissingError
	A MapValidationError that indicates that the map checker script could not be found. More...
class	MapDifficultyChecker
	Validator that checks whether the map has a valid difficulty. More...
class	MobOutsideSpawnPointChecker
	GameObjectValidator to assert that mobs are not outside spawn points. More...
class	NonAbsoluteExitPathError
	A GameObjectValidationError that describes an exit GameObject having an invalid exit path. More...
class	PaidItemShopSquareChecker
	A net.sf.gridarta.model.validation.MapValidator to detect shop squares that contain paid items. More...
class	Range
	Represents a range of attribute values. More...
class	RangeEntry
	An attribute to check. More...
class	ShopSquareChecker
	A net.sf.gridarta.model.validation.MapValidator to detect shop squares which allow magic or prayers. More...
class	SlayingChecker
	An GameObjectValidator to assert that game objects do not have critical slaying strings. More...
class	SquareWithoutFloorChecker
	A SquareValidator to assert that squares have a floor. More...
class	SysObjectNotOnLayerZeroChecker
	A GameObjectValidator to assert that sys objects are only in layer 0. More...
class	TilePathsChecker
	Validator that checks whether all tile paths are valid. More...
class	Type
	Manages all checks for one game object type. More...
class	UndefinedArchetypeChecker
	Check that no game object references an undefined archetype. More...
class	UndefinedFaceChecker
	Checks that a game object does not reference an undefined face. More...
class	UnsetSlayingChecker
	Checks that a game object does not set a custom type. More...
class	ValidatorFactory
	A factory for creating Validator instances from string representation. More...
class	ValidatorFactoryTest
	Regression tests for net.sf.gridarta.model.validation.checks.ValidatorFactory to create validators. More...

Detailed Description

This package contains the checks for validating maps.

How to create your own checks

The easiest way to create your own checks is this:

1. Extend AbstractValidator by a class named like net.sf.gridarta.map.validation.checks.MyMapChecker that additionally implements one of the Validator sub-interfaces
2. Extend ValidationError or one of its subclasses by a class named like

   net.sf.gridarta.map.model.validation.checks.MyError 

   .

Note: to use the automatic localization feature, the error class and validator class must match name like the existing checkers.

Caveats

If you extend AbstractValidator without actually really implementing one of the Validator, your validator will be a valid and compilable validator but also a dysfunctional stub. So don't forget to extend the corresponding sub-interface.

FAQ

Do I really have to always extend ValidationError for my validator's errors?

Well not really. But the automatic localization of

ValidationError 

s depends on separate error class names. Also, CorrectableError depends on separate error classes.