Gridarta Editor
DelegatingMapValidator.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;
21 
22 import java.util.ArrayList;
23 import java.util.Collection;
24 import java.util.Iterator;
30 import org.jetbrains.annotations.NotNull;
31 
36 public class DelegatingMapValidator<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractValidator<G, A, R> implements GameObjectValidator<G, A, R>, SquareValidator<G, A, R>, MapValidator<G, A, R>, Iterable<Validator<G, A, R>> {
37 
41  @NotNull
42  private final Collection<Validator<G, A, R>> validators = new ArrayList<>();
43 
47  @NotNull
48  public static final String DEFAULT_KEY = "Validator.All";
49 
56  }
57 
63  private DelegatingMapValidator(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final String key) {
64  super(validatorPreferences, key);
65  }
66 
71  public void validateAll(@NotNull final MapModel<G, A, R> mapModel) {
72  final ErrorCollector<G, A, R> errorCollector = new DefaultErrorCollector<>();
73  validateMap(mapModel, errorCollector);
74  for (final MapSquare<G, A, R> mapSquare : mapModel) {
75  validateSquare(mapSquare, errorCollector);
76  for (final G archObject : mapSquare) {
77  validateGameObject(archObject, errorCollector);
78  for (final G invObject : archObject.recursive()) {
79  validateGameObject(invObject, errorCollector);
80  }
81  }
82  }
83  mapModel.setErrors(errorCollector);
84  }
85 
86  @Override
87  public void validateMap(@NotNull final MapModel<G, A, R> mapModel, @NotNull final ErrorCollector<G, A, R> errorCollector) {
88  for (final Validator<G, A, R> validator : validators) {
89  if (validator.isEnabled()) {
90  if (validator instanceof MapValidator) {
91  ((MapValidator<G, A, R>) validator).validateMap(mapModel, errorCollector);
92  }
93  }
94  }
95  }
96 
97  @Override
98  public void validateSquare(@NotNull final MapSquare<G, A, R> mapSquare, @NotNull final ErrorCollector<G, A, R> errorCollector) {
99  for (final Validator<G, A, R> validator : validators) {
100  if (validator.isEnabled() && validator instanceof SquareValidator) {
101  ((SquareValidator<G, A, R>) validator).validateSquare(mapSquare, errorCollector);
102  }
103  }
104  }
105 
106  @Override
107  public void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector) {
108  for (final Validator<G, A, R> validator : validators) {
109  if (validator.isEnabled() && validator instanceof GameObjectValidator) {
110  ((GameObjectValidator<G, A, R>) validator).validateGameObject(gameObject, errorCollector);
111  }
112  }
113  }
114 
121  public void addValidator(@NotNull final Validator<G, A, R> validator) {
122  validators.add(validator);
123  }
124 
125  @NotNull
126  @Override
127  public Iterator<Validator<G, A, R>> iterator() {
128  return validators.iterator();
129  }
130 
131 }
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.model.validation.DelegatingMapValidator.DelegatingMapValidator
DelegatingMapValidator(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final String key)
Creates a new instance for a specific key.
Definition: DelegatingMapValidator.java:63
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.validation.SquareValidator
Interface for Square Validators.
Definition: SquareValidator.java:33
net.sf.gridarta.model.mapmodel.MapSquare
A single Map Square.
Definition: MapSquare.java:45
net.sf.gridarta.model.validation.DelegatingMapValidator.iterator
Iterator< Validator< G, A, R > > iterator()
Definition: DelegatingMapValidator.java:127
net.sf
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
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.validation.Validator< G, A, R >
net.sf.gridarta.model.validation.AbstractValidator< G, A, R >::validatorPreferences
final ValidatorPreferences validatorPreferences
The ValidatorPreferences to use.
Definition: AbstractValidator.java:55
net.sf.gridarta.model.validation.AbstractValidator< G, A, R >::key
final String key
Key.
Definition: AbstractValidator.java:61
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.sf.gridarta.model.validation.DelegatingMapValidator.validateGameObject
void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector< G, A, R > errorCollector)
Definition: DelegatingMapValidator.java:107
net.sf.gridarta.model.validation.DelegatingMapValidator.validateSquare
void validateSquare(@NotNull final MapSquare< G, A, R > mapSquare, @NotNull final ErrorCollector< G, A, R > errorCollector)
Definition: DelegatingMapValidator.java:98
net
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.ErrorCollector< G, A, R >
net.sf.gridarta.model.validation.AbstractValidator
This is the base class for validators.
Definition: AbstractValidator.java:37
net.sf.gridarta.model.validation.DelegatingMapValidator.validateAll
void validateAll(@NotNull final MapModel< G, A, R > mapModel)
Performs all validations on a map.
Definition: DelegatingMapValidator.java:71
net.sf.gridarta.model.validation.DelegatingMapValidator.DelegatingMapValidator
DelegatingMapValidator(@NotNull final ValidatorPreferences validatorPreferences)
Creates a new instance for the default key.
Definition: DelegatingMapValidator.java:54
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.validation.DelegatingMapValidator.addValidator
void addValidator(@NotNull final Validator< G, A, R > validator)
Adds a Validator that might to be queried.
Definition: DelegatingMapValidator.java:121
net.sf.gridarta.model.validation.GameObjectValidator
Interface for GameObject Validators.
Definition: GameObjectValidator.java:32
net.sf.gridarta.model.validation.DefaultErrorCollector
Simple error collector that just collects the error in a collection for later retrieval through itera...
Definition: DefaultErrorCollector.java:37
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.validation.DelegatingMapValidator.validateMap
void validateMap(@NotNull final MapModel< G, A, R > mapModel, @NotNull final ErrorCollector< G, A, R > errorCollector)
Definition: DelegatingMapValidator.java:87
net.sf.gridarta.model.validation.DelegatingMapValidator
A Map Validator that delegates to other MapValidators.
Definition: DelegatingMapValidator.java:36
net.sf.gridarta.model.validation.DelegatingMapValidator.validators
final Collection< Validator< G, A, R > > validators
Map Validators to validate against.
Definition: DelegatingMapValidator.java:42
net.sf.gridarta.model.validation.DelegatingMapValidator.DEFAULT_KEY
static final String DEFAULT_KEY
The default key.
Definition: DelegatingMapValidator.java:48