net.sf.gridarta.plugin.parameter

Class AbstractPathParameter<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.plugin.parameter.AbstractPluginParameter<G,A,R,V>

net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter<G,A,R,java.io.File>

net.sf.gridarta.plugin.parameter.AbstractPathParameter<G,A,R>

All Implemented Interfaces:

PluginParameter<G,A,R,java.io.File>

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,java.io.File>

Base class for PluginParameters that hold a File value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPathParameter(@NotNull java.io.File baseDir) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@NotNull java.io.File	getBaseDir() Returns the base directory.
@NotNull java.io.File	getValue() Returns the current value of this parameter.
@Nullable java.io.File	getValueOrNull() Returns the current value of this parameter.
void	setFile(@NotNull java.io.File file) Sets the current File.

Methods inherited from class net.sf.gridarta.plugin.parameter.AbstractStringPluginParameter

getStringValue, setStringValue

Methods inherited from class net.sf.gridarta.plugin.parameter.AbstractPluginParameter

addPluginParameterListener, changed, getDescription, getName, removePluginParameterListener, setDescription, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.gridarta.plugin.parameter.PluginParameter

getParameterType, visit

Constructor Detail

AbstractPathParameter

protected AbstractPathParameter(@NotNull
                                @NotNull java.io.File baseDir)

Creates a new instance.

Parameters:

baseDir - the base directory

Method Detail

getBaseDir

@NotNull
public @NotNull java.io.File getBaseDir()

Returns the base directory.

Returns:

the base directory

setFile

public void setFile(@NotNull
                    @NotNull java.io.File file)

Sets the current File.

Parameters:

file - the file

getValue

@NotNull
public @NotNull java.io.File getValue()
                                        throws InvalidValueException

Description copied from interface: PluginParameter

Returns the current value of this parameter.

Returns:

the value

Throws:

InvalidValueException - if the the value is invalid

getValueOrNull

@Nullable
public @Nullable java.io.File getValueOrNull()

Description copied from interface: PluginParameter

Returns the current value of this parameter.

Returns:

the value or null if the the value is invalid