Gridarta Editor
AbstractPathParameter.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.plugin.parameter;
21 
22 import java.io.File;
27 import org.jetbrains.annotations.NotNull;
28 import org.jetbrains.annotations.Nullable;
29 
35 public abstract class AbstractPathParameter<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractStringPluginParameter<G, A, R, File> {
36 
40  @NotNull
41  private final File baseDir;
42 
47  protected AbstractPathParameter(@NotNull final File baseDir) {
48  super("");
49  this.baseDir = baseDir;
50  }
51 
56  @NotNull
57  public File getBaseDir() {
58  return baseDir;
59  }
60 
65  public void setFile(@NotNull final File file) {
67  }
68 
69  @NotNull
70  @Override
71  public File getValue() throws InvalidValueException {
72  final String stringValue = getStringValue();
73  if (stringValue.isEmpty()) {
74  throw new InvalidValueException("not value specified");
75  }
76  final File file = new File(stringValue);
77  if (!file.exists()) {
78  throw new InvalidValueException("file does not exist: " + stringValue);
79  }
80  return file;
81  }
82 
83  @Nullable
84  @Override
85  public File getValueOrNull() {
86  try {
87  return getValue();
88  } catch (final InvalidValueException ignored) {
89  return null;
90  }
91  }
92 
93 }
net.sf.gridarta.plugin.parameter.AbstractPathParameter.getValue
File getValue()
Definition: AbstractPathParameter.java:71
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.plugin.parameter.AbstractStringPluginParameter< G, A, R, File >::stringValue
String stringValue
The current value.
Definition: AbstractStringPluginParameter.java:38
net.sf.gridarta.plugin.parameter.AbstractPathParameter.setFile
void setFile(@NotNull final File file)
Sets the current File.
Definition: AbstractPathParameter.java:65
net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, File >::getStringValue
String getStringValue()
Definition: AbstractStringPluginParameter.java:50
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.plugin.parameter.AbstractPathParameter.getBaseDir
File getBaseDir()
Returns the base directory.
Definition: AbstractPathParameter.java:57
net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter
Abstract base class for PluginParameter implementations for which the value is calculated from the st...
Definition: AbstractStringPluginParameter.java:32
net.sf.gridarta.utils.PathManagerUtils.getMapPath
static String getMapPath(@NotNull final File file, @NotNull final File baseDir)
Returns a relative path path for a File.
Definition: PathManagerUtils.java:58
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.plugin.parameter.AbstractPathParameter.AbstractPathParameter
AbstractPathParameter(@NotNull final File baseDir)
Creates a new instance.
Definition: AbstractPathParameter.java:47
net.sf.gridarta.plugin.parameter.AbstractPathParameter.baseDir
final File baseDir
The base directory.
Definition: AbstractPathParameter.java:41
net.sf.gridarta.plugin.parameter.InvalidValueException
An exception that is thrown if the string representation of value in a {} cannot be converted to an o...
Definition: InvalidValueException.java:30
net.sf.gridarta.utils.PathManagerUtils
Utility class for converting relative map paths to absolute map paths and vice versa.
Definition: PathManagerUtils.java:31
net.sf.gridarta.plugin.parameter.AbstractPathParameter.getValueOrNull
File getValueOrNull()
Definition: AbstractPathParameter.java:85
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.plugin.parameter.AbstractPathParameter
Base class for PluginParameters that hold a {} value.
Definition: AbstractPathParameter.java:35
net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, File >::setStringValue
boolean setStringValue( @NotNull final String stringValue)
Updates the parameter value.
Definition: AbstractStringPluginParameter.java:59
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20