Gridarta Editor
TilePathsChecker.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.model.validation.checks;
21 
22 import java.io.File;
36 import org.jetbrains.annotations.NotNull;
37 
42 public class TilePathsChecker<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractValidator<G, A, R> implements MapValidator<G, A, R> {
43 
47  private final int tilePaths;
48 
55  super(validatorPreferences);
56  this.tilePaths = tilePaths;
57  }
58 
59  @Override
60  public void validateMap(@NotNull final MapModel<G, A, R> mapModel, @NotNull final ErrorCollector<G, A, R> errorCollector) {
61  final MapArchObject<A> mapArchObject = mapModel.getMapArchObject();
62  final Direction[] directions = Direction.values();
63  for (int direction = 0; direction < tilePaths; direction++) {
64  final String path = mapArchObject.getTilePath(directions[direction]);
65  if (!path.isEmpty()) {
66  try {
67  final File file = mapModel.getMapFile(MapPathUtils.newMapPath(path)).getFile();
68  if (!file.exists() || file.isDirectory()) {
69  errorCollector.collect(new TilePathsError<>(mapModel, directions[direction], path));
70  }
71  } catch (final SameMapException | UnsavedMapException ignored) {
72  }
73  }
74  }
75  }
76 
77 }
net.sf.gridarta.model.direction.Direction
A direction.
Definition: Direction.java:28
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.model.mapmodel.SameMapException
Exception thrown if the destination path points to the source map.
Definition: SameMapException.java:26
net.sf.gridarta.model.validation.checks.TilePathsChecker
Validator that checks whether all tile paths are valid.
Definition: TilePathsChecker.java:42
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.model.maparchobject.MapArchObject.getTilePath
String getTilePath(@NotNull Direction direction)
Returns a tile path.
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.model.validation.checks.TilePathsChecker.tilePaths
final int tilePaths
The number of tile paths to check.
Definition: TilePathsChecker.java:47
net.sf.gridarta.model.mapmodel.MapPathUtils.newMapPath
static MapPath newMapPath(@NotNull final String string)
Creates a MapPath instance from string representation.
Definition: MapPathUtils.java:43
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.mapmodel.MapPathUtils
Utility class for MapPath related functions.
Definition: MapPathUtils.java:28
net.sf.gridarta.model.validation.AbstractValidator.validatorPreferences
final ValidatorPreferences validatorPreferences
The ValidatorPreferences to use.
Definition: AbstractValidator.java:55
net.sf.gridarta.model.validation.checks.TilePathsChecker.validateMap
void validateMap(@NotNull final MapModel< G, A, R > mapModel, @NotNull final ErrorCollector< G, A, R > errorCollector)
Validate a map.
Definition: TilePathsChecker.java:60
net.sf.gridarta.model.validation.MapValidator
Interface for Map Validators.
Definition: MapValidator.java:33
net.sf.gridarta.model.validation.ValidatorPreferences
Configuration parameters for Validators.
Definition: ValidatorPreferences.java:28
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.ErrorCollector
An interface for classes that collect errors.
Definition: ErrorCollector.java:33
net.sf.gridarta.model.validation.AbstractValidator
This is the base class for validators.
Definition: AbstractValidator.java:37
net.sf.gridarta.model.mapmodel.UnsavedMapException
Exception thrown if an operation is attempted on an unsaved map.
Definition: UnsavedMapException.java:26
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model.validation.errors.TilePathsError
Validation error that's used when a map has wrong tile paths.
Definition: TilePathsError.java:34
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.validation.checks.TilePathsChecker.TilePathsChecker
TilePathsChecker(@NotNull final ValidatorPreferences validatorPreferences, final int tilePaths)
Creates a new instance.
Definition: TilePathsChecker.java:54
net.sf.gridarta.model.validation.errors
Definition: AttributeRangeError.java:20
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.direction
Definition: Direction.java:20