Gridarta Editor
AbstractValidator.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 
26 import net.sf.japi.swing.action.ActionBuilder;
27 import net.sf.japi.swing.action.ActionBuilderFactory;
28 import org.jetbrains.annotations.NotNull;
29 
37 public abstract class AbstractValidator<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements Validator<G, A, R> {
38 
42  @NotNull
43  private static final String VALIDATOR_PREFIX = "Validator.";
44 
48  @NotNull
49  private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
50 
54  @NotNull
56 
60  @NotNull
61  private final String key;
62 
66  private boolean enabled;
67 
71  private final boolean defaultEnabled;
72 
80  protected AbstractValidator(@NotNull final ValidatorPreferences validatorPreferences) throws IllegalArgumentException {
81  this.validatorPreferences = validatorPreferences;
82  final String name = getClass().getSimpleName();
83  if (!name.endsWith("Checker")) {
84  throw new IllegalArgumentException("Class name must end with \"Checker\"");
85  }
86  key = VALIDATOR_PREFIX + name.substring(0, name.lastIndexOf("Checker"));
87  final String defaultEnabledString = ActionBuilderUtils.getString(ACTION_BUILDER, key + ".default");
88  defaultEnabled = Boolean.parseBoolean(defaultEnabledString);
90  }
91 
97  protected AbstractValidator(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final String key) {
98  this.validatorPreferences = validatorPreferences;
99  this.key = key;
100  final String defaultEnabledString = ActionBuilderUtils.getString(ACTION_BUILDER, key + ".default");
101  defaultEnabled = Boolean.parseBoolean(defaultEnabledString);
103  }
104 
105  @NotNull
106  @Override
107  public String getKey() {
108  return key;
109  }
110 
111  @Override
112  public void setEnabled(final boolean enabled) {
113  if (this.enabled == enabled) {
114  return;
115  }
116 
117  this.enabled = enabled;
119  }
120 
121  @Override
122  public boolean isEnabled() {
123  return enabled;
124  }
125 
126  @Override
127  public boolean isDefaultEnabled() {
128  return defaultEnabled;
129  }
130 
131 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.model.validation.AbstractValidator.getKey
String getKey()
Definition: AbstractValidator.java:107
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.validation.ValidatorPreferences.loadEnabled
boolean loadEnabled(@NotNull String key, boolean defaultEnabled)
Loads the stored "enabled" attribute.
net.sf
net.sf.gridarta.model.validation.ValidatorPreferences.saveEnabled
void saveEnabled(@NotNull String key, boolean enabled)
Saves the "enabled" attribute.
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
Super-interface for validators.
Definition: Validator.java:31
net.sf.gridarta.model.validation.AbstractValidator.validatorPreferences
final ValidatorPreferences validatorPreferences
The ValidatorPreferences to use.
Definition: AbstractValidator.java:55
net.sf.gridarta.model.validation.AbstractValidator.key
final String key
Key.
Definition: AbstractValidator.java:61
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.AbstractValidator.setEnabled
void setEnabled(final boolean enabled)
Definition: AbstractValidator.java:112
net.sf.gridarta.model.validation.AbstractValidator.AbstractValidator
AbstractValidator(@NotNull final ValidatorPreferences validatorPreferences)
Creates a new instance.
Definition: AbstractValidator.java:80
net.sf.gridarta.model.validation.AbstractValidator.AbstractValidator
AbstractValidator(@NotNull final ValidatorPreferences validatorPreferences, @NotNull final String key)
Creates a new instance.
Definition: AbstractValidator.java:97
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.AbstractValidator.ACTION_BUILDER
static final ActionBuilder ACTION_BUILDER
Action Builder.
Definition: AbstractValidator.java:49
net.sf.gridarta.model.validation.AbstractValidator
This is the base class for validators.
Definition: AbstractValidator.java:37
net.sf.gridarta.model.validation.AbstractValidator.enabled
boolean enabled
Whether this MapValidator is enabled.
Definition: AbstractValidator.java:66
net.sf.gridarta.utils.ActionBuilderUtils.getString
static String getString(@NotNull final ActionBuilder actionBuilder, @NotNull final String key, @NotNull final String defaultValue)
Returns the value of a key.
Definition: ActionBuilderUtils.java:71
net.sf.gridarta.model.validation.AbstractValidator.defaultEnabled
final boolean defaultEnabled
Whether this MapValidator is enabled by default.
Definition: AbstractValidator.java:71
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.utils.ActionBuilderUtils
Utility class for ActionBuilder related functions.
Definition: ActionBuilderUtils.java:31
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.validation.AbstractValidator.VALIDATOR_PREFIX
static final String VALIDATOR_PREFIX
The prefix for preference keys.
Definition: AbstractValidator.java:43
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.model.validation.AbstractValidator.isEnabled
boolean isEnabled()
Definition: AbstractValidator.java:122
net.sf.gridarta.model.validation.AbstractValidator.isDefaultEnabled
boolean isDefaultEnabled()
Definition: AbstractValidator.java:127