Gridarta Editor
EnvironmentInvError.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.errors;
21 
25 import org.jetbrains.annotations.NotNull;
26 import org.jetbrains.annotations.Nullable;
27 
33 public class EnvironmentInvError<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends GameObjectValidationError<G, A, R> {
34 
38  private static final long serialVersionUID = 1L;
39 
43  @NotNull
44  private final String typeDescription;
45 
49  @NotNull
50  private final String envTypeDescription;
51 
58  public EnvironmentInvError(@NotNull final G gameObject, @NotNull final String typeDescription, @NotNull final String envTypeDescription) {
59  super(gameObject);
60  this.typeDescription = typeDescription;
61  this.envTypeDescription = envTypeDescription;
62  }
63 
64  @Nullable
65  @Override
66  public String getParameter(final int id) {
67  switch (id) {
68  case 0:
69  return typeDescription;
70 
71  case 1:
72  return envTypeDescription;
73 
74  default:
75  return null;
76  }
77  }
78 
79 }
net.sf.gridarta.model.validation.errors.EnvironmentInvError.envTypeDescription
final String envTypeDescription
The environment type's description.
Definition: EnvironmentInvError.java:50
net.sf.gridarta
Base package of all Gridarta classes.
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.errors.GameObjectValidationError
Class for validation errors related to a GameObject.
Definition: GameObjectValidationError.java:31
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.errors.EnvironmentInvError.getParameter
String getParameter(final int id)
Definition: EnvironmentInvError.java:66
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.errors.EnvironmentInvError.typeDescription
final String typeDescription
The type's description.
Definition: EnvironmentInvError.java:44
net.sf.gridarta.model.validation.errors.EnvironmentInvError.EnvironmentInvError
EnvironmentInvError(@NotNull final G gameObject, @NotNull final String typeDescription, @NotNull final String envTypeDescription)
Creates a new instance.
Definition: EnvironmentInvError.java:58
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.validation.errors.EnvironmentInvError
Validation error that's used when the EnvironmentChecker detected a possible error on the map.
Definition: EnvironmentInvError.java:33
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.validation.errors.EnvironmentInvError.serialVersionUID
static final long serialVersionUID
The serial version UID.
Definition: EnvironmentInvError.java:38