Gridarta Editor
RangeEntry.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 
27 import org.jetbrains.annotations.NotNull;
28 
33 public class RangeEntry<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
34 
38  @NotNull
39  private final String displayName;
40 
44  @NotNull
45  private final Range range;
46 
52  public RangeEntry(@NotNull final String displayName, @NotNull final Range range) {
53  this.displayName = displayName;
54  this.range = range;
55  }
56 
63  public void validate(final int value, @NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector) {
64  if (!range.isWithinRange(value)) {
65  errorCollector.collect(new AttributeRangeError<>(gameObject, displayName, Integer.toString(value), Integer.toString(range.getMin()), Integer.toString(range.getMax())));
66  }
67  }
68 
69 }
net.sf.gridarta.model.validation.checks.RangeEntry.displayName
final String displayName
The attribute name to display in error messages.
Definition: RangeEntry.java:39
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.validation.checks.RangeEntry.RangeEntry
RangeEntry(@NotNull final String displayName, @NotNull final Range range)
Creates a new instance.
Definition: RangeEntry.java:52
net.sf.gridarta.model.validation.checks.RangeEntry.range
final Range range
The attribute values range to check for.
Definition: RangeEntry.java:45
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.RangeEntry
An attribute to check.
Definition: RangeEntry.java:33
net.sf.gridarta.model.validation.checks.Range.isWithinRange
boolean isWithinRange(final int value)
Returns whether a given attribute value is within the valid attribute values range.
Definition: Range.java:58
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
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model.validation.checks.Range
Represents a range of attribute values.
Definition: Range.java:26
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.validation.errors.AttributeRangeError
Indicate an attribute value that is out of range.
Definition: AttributeRangeError.java:32
net.sf.gridarta.model.validation.checks.Range.getMin
int getMin()
Returns the minimum allowed value.
Definition: Range.java:66
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.Range.getMax
int getMax()
Returns the maximum allowed value.
Definition: Range.java:74
net.sf.gridarta.model.validation.checks.RangeEntry.validate
void validate(final int value, @NotNull final G gameObject, @NotNull final ErrorCollector< G, A, R > errorCollector)
Validates an attribute value.
Definition: RangeEntry.java:63