Gridarta Editor
UnsetSlayingChecker.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.Arrays;
23 import java.util.Collection;
24 import java.util.HashSet;
34 import org.jetbrains.annotations.NotNull;
35 
40 public class UnsetSlayingChecker<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> {
41 
45  @NotNull
46  private final Collection<Integer> typeNumbers = new HashSet<>();
47 
51  @NotNull
52  private final Collection<String> allowedValues = new HashSet<>();
53 
59  public UnsetSlayingChecker(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final Integer... typeNumbers) {
60  super(validatorPreferences);
61  allowedValues.add("");
62  this.typeNumbers.addAll(Arrays.asList(typeNumbers));
63  }
64 
69  public void addAllowedValue(@NotNull final String value) {
70  allowedValues.add(value);
71  }
72 
73  @Override
74  public void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector) {
75  if (typeNumbers.contains(gameObject.getTypeNo())) {
76  final String slayingArchetype = gameObject.getArchetype().getAttributeString(BaseObject.SLAYING);
77  if (!allowedValues.contains(slayingArchetype)) {
78  final String slayingObject = gameObject.getAttributeString(BaseObject.SLAYING);
79  if (slayingArchetype.equals(slayingObject)) {
80  errorCollector.collect(new UnsetSlayingError<>(gameObject));
81  }
82  }
83  }
84  }
85 
86 }
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.validation.checks.UnsetSlayingChecker.validateGameObject
void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector< G, A, R > errorCollector)
Validates a game object.
Definition: UnsetSlayingChecker.java:74
net.sf
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.checks.UnsetSlayingChecker.addAllowedValue
void addAllowedValue(@NotNull final String value)
Adds a value which does not trigger a warning.
Definition: UnsetSlayingChecker.java:69
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.validation.checks.UnsetSlayingChecker.allowedValues
final Collection< String > allowedValues
The values which do not trigger a warning.
Definition: UnsetSlayingChecker.java:52
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.errors.UnsetSlayingError
Validation error indicating a game object with a custom type.
Definition: UnsetSlayingError.java:32
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.validation.checks.UnsetSlayingChecker
Checks that a game object does not set a custom type.
Definition: UnsetSlayingChecker.java:40
net.sf.gridarta.model.baseobject.BaseObject
Definition: BaseObject.java:34
net.sf.gridarta.model
net.sf.gridarta.model.validation.checks.UnsetSlayingChecker.UnsetSlayingChecker
UnsetSlayingChecker(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final Integer... typeNumbers)
Creates a new instance.
Definition: UnsetSlayingChecker.java:59
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.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.UnsetSlayingChecker.typeNumbers
final Collection< Integer > typeNumbers
The object types to check.
Definition: UnsetSlayingChecker.java:46