Gridarta Editor
SlayingChecker.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.util.ArrayList;
23 import java.util.Collection;
24 import java.util.regex.Pattern;
35 import org.jetbrains.annotations.NotNull;
36 
42 public class SlayingChecker<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> {
43 
48  @NotNull
49  private final Pattern defaultRegex;
50 
54  @NotNull
55  private final Collection<Entry<G, A, R>> entries = new ArrayList<>();
56 
63  public SlayingChecker(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final Pattern defaultRegex) {
64  super(validatorPreferences);
65  this.defaultRegex = defaultRegex;
66  }
67 
73  public void addMatcher(@NotNull final GameObjectMatcher gameObjectMatcher, @NotNull final Pattern regex) {
74  entries.add(new Entry<>(gameObjectMatcher, regex));
75  }
76 
77  @Override
78  public void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector) {
79  boolean useDefaultRegex = true;
80  for (final Entry<G, A, R> entry : entries) {
81  if (entry.validate(gameObject, errorCollector)) {
82  useDefaultRegex = false;
83  }
84  }
85 
86  if (useDefaultRegex) {
87  final CharSequence slaying = gameObject.getAttributeString(BaseObject.SLAYING, true);
88  if (!defaultRegex.matcher(slaying).matches()) {
89  errorCollector.collect(new SlayingError<>(gameObject));
90  }
91  }
92  }
93 
94 }
net.sf.gridarta.model.validation.errors.SlayingError
Validation error that's used when the SlayingChecker detected a possible error on the map.
Definition: SlayingError.java:34
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.model.validation.checks.SlayingChecker.entries
final Collection< Entry< G, A, R > > entries
The matchers to check.
Definition: SlayingChecker.java:55
net.sf.gridarta.model.match.GameObjectMatcher
Interface for classes that match GameObjects.
Definition: GameObjectMatcher.java:30
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.validation.checks.SlayingChecker.defaultRegex
final Pattern defaultRegex
The regular expression for any "slaying" field not matching any specific game object.
Definition: SlayingChecker.java:49
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.validation.checks.SlayingChecker.SlayingChecker
SlayingChecker(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final Pattern defaultRegex)
Creates a new instance.
Definition: SlayingChecker.java:63
net.sf.gridarta.model.validation.AbstractValidator.validatorPreferences
final ValidatorPreferences validatorPreferences
The ValidatorPreferences to use.
Definition: AbstractValidator.java:55
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.match
Classes related to matching {GameObjects}, so called { net.sf.gridarta.model.match....
Definition: AndGameObjectMatcher.java:20
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.checks.SlayingChecker.validateGameObject
void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector< G, A, R > errorCollector)
Validates a game object.
Definition: SlayingChecker.java:78
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.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model.baseobject.BaseObject.SLAYING
String SLAYING
The name of the "slaying" attribute.
Definition: BaseObject.java:120
net.sf.gridarta.model.baseobject.BaseObject
Definition: BaseObject.java:34
net.sf.gridarta.model.validation.checks.SlayingChecker.addMatcher
void addMatcher(@NotNull final GameObjectMatcher gameObjectMatcher, @NotNull final Pattern regex)
Adds a matcher to check.
Definition: SlayingChecker.java:73
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.baseobject
Definition: AbstractBaseObject.java:20
net.sf.gridarta.model.validation.checks.Entry
An entry to match consisting of a GameObjectMatcher and a regular expression which defined the allowe...
Definition: Entry.java:37
net.sf.gridarta.model.validation.GameObjectValidator
Interface for GameObject Validators.
Definition: GameObjectValidator.java:32
net.sf.gridarta.model.validation.errors
Definition: AttributeRangeError.java:20
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.validation.checks.SlayingChecker
A GameObjectValidator to assert that game objects do not have critical slaying strings.
Definition: SlayingChecker.java:42