Gridarta Editor
net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Class Template Reference

A PluginParameter that holds a path with in the maps directory. More...

+ Inheritance diagram for net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
+ Collaboration diagram for net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions

String getParameterType ()
 
String getValue ()
 
String getValueOrNull ()
 
 MapPathParameter (@NotNull final PathManager pathManager, @NotNull final ProjectSettings projectSettings)
 Creates a new instance. More...
 
void setFile (@NotNull final File file) throws InvalidValueException
 Sets the value from a File instance. More...
 
- Public Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, String >
String getStringValue ()
 
boolean setStringValue ( @NotNull final String stringValue)
 Updates the parameter value. More...
 

Static Public Attributes

static final String PARAMETER_TYPE = "MapPathParameter"
 The string representation of this parameter type. More...
 

Package Functions

public< T > T visit (@NotNull final PluginParameterVisitor< G, A, R, T > visitor)
 

Private Attributes

final PathManager pathManager
 The PathManager instance for converting Files into path names. More...
 
final ProjectSettings projectSettings
 The ProjectSettings instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, String >
 AbstractStringPluginParameter ( @NotNull final String stringValue)
 Creates a new instance. More...
 

Detailed Description

A PluginParameter that holds a path with in the maps directory.

Definition at line 35 of file MapPathParameter.java.

Constructor & Destructor Documentation

◆ MapPathParameter()

net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.MapPathParameter ( @NotNull final PathManager  pathManager,
@NotNull final ProjectSettings  projectSettings 
)

Member Function Documentation

◆ getParameterType()

◆ getValue()

◆ getValueOrNull()

String net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getValueOrNull ( )

◆ setFile()

◆ visit()

public<T> T net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.visit ( @NotNull final PluginParameterVisitor< G, A, R, T >  visitor)
package

Definition at line 76 of file MapPathParameter.java.

Member Data Documentation

◆ PARAMETER_TYPE

◆ pathManager

◆ projectSettings


The documentation for this class was generated from the following file: