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...

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
	)

Creates a new instance.

Parameters

pathManager	the path manager instance for converting files into path names
projectSettings	the project settings instance

Definition at line 62 of file MapPathParameter.java.

References net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pathManager, and net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.projectSettings.

Member Function Documentation

◆ getParameterType()

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

Definition at line 70 of file MapPathParameter.java.

References net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.PARAMETER_TYPE.

◆ getValue()

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

Definition at line 82 of file MapPathParameter.java.

References net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter< G, A, R, String >.getStringValue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 ( )

Definition at line 88 of file MapPathParameter.java.

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

Here is the call graph for this function:

◆ setFile()

void net.sf.gridarta.plugin.parameter.MapPathParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setFile ( @NotNull final File file ) throws InvalidValueException