Base class for PluginParameters that hold a File value. More...
Inheritance diagram for net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Collaboration diagram for net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
Public Member Functions | |
| File | getBaseDir () |
| Returns the base directory. More... | |
| File | getValue () throws InvalidValueException |
| File | getValueOrNull () |
| void | setFile (@NotNull final File file) |
| Sets the current File. More... | |
| Public Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, File > | |
| String | getStringValue () |
| boolean | setStringValue ( @NotNull final String stringValue) |
| Updates the parameter value. More... | |
Protected Member Functions | |
| AbstractPathParameter (@NotNull final File baseDir) | |
| Creates a new instance. More... | |
| Protected Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, File > | |
| AbstractStringPluginParameter ( @NotNull final String stringValue) | |
| Creates a new instance. More... | |
Private Attributes | |
| final File | baseDir |
| The base directory. More... | |
Detailed Description
Base class for PluginParameters that hold a File value.
Definition at line 35 of file AbstractPathParameter.java.
Constructor & Destructor Documentation
◆ AbstractPathParameter()
|
protected |
Creates a new instance.
- Parameters
-
baseDir the base directory
Definition at line 47 of file AbstractPathParameter.java.
Member Function Documentation
◆ getBaseDir()
| File net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getBaseDir | ( | ) |
Returns the base directory.
- Returns
- the base directory
Definition at line 57 of file AbstractPathParameter.java.
◆ getValue()
| File net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValue | ( | ) | throws InvalidValueException |
Definition at line 71 of file AbstractPathParameter.java.
References net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, File >.getStringValue(), and net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, File >.stringValue.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getValueOrNull()
| File net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValueOrNull | ( | ) |
◆ setFile()
| void net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setFile | ( | @NotNull final File | file | ) |
Sets the current File.
- Parameters
-
file the file
Definition at line 65 of file AbstractPathParameter.java.
References net.sf.gridarta.model.io.PathManagerUtils.getMapPath(), and net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, File >.setStringValue().
Here is the call graph for this function:
Member Data Documentation
◆ baseDir
|
private |
The base directory.
Definition at line 41 of file AbstractPathParameter.java.
Referenced by net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.AbstractPathParameter(), and net.sf.gridarta.plugin.parameter.AbstractPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getBaseDir().
The documentation for this class was generated from the following file:
- gridarta-gridarta/src/plugin/src/main/java/net/sf/gridarta/plugin/parameter/AbstractPathParameter.java
