Gridarta Editor
net.sf.gridarta.model.configsource.AbstractConfigSource Class Referenceabstract

Abstract base class for ConfigSource implementations. More...

+ Inheritance diagram for net.sf.gridarta.model.configsource.AbstractConfigSource:
+ Collaboration diagram for net.sf.gridarta.model.configsource.AbstractConfigSource:

Public Member Functions

File getFile (@NotNull final ProjectSettings projectSettings, @NotNull final String type, final int index) throws IOException
 Returns a config file. More...
 
String toString ()
 
- Public Member Functions inherited from net.sf.gridarta.model.configsource.ConfigSource
String getName ()
 Returns the internal name. More...
 
boolean isArchDirectoryInputFieldEnabled ()
 Whether the "archetype directory" input field in the settings dialog should be enabled. More...
 
< G extends GameObject< G, A, R > A extends R extends Archetype< G, A, R > void read (@NotNull ProjectSettings projectSettings, @NotNull AbstractResources< G, A, R > resources, @NotNull ErrorView errorView)
 

Static Private Attributes

static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
 The ActionBuilder. More...
 

Additional Inherited Members

- Public Attributes inherited from net.sf.gridarta.model.configsource.ConfigSource
< G extends GameObject< G, A, R > A extends MapArchObject< A >
 

Detailed Description

Abstract base class for ConfigSource implementations.

Author
Andreas Kirschbaum

Definition at line 37 of file AbstractConfigSource.java.

Member Function Documentation

◆ getFile()

File net.sf.gridarta.model.configsource.AbstractConfigSource.getFile ( @NotNull final ProjectSettings  projectSettings,
@NotNull final String  type,
final int  index 
) throws IOException

Returns a config file.

Parameters
projectSettingsthe project settings to use
typethe file type
indexthe file index, starting with
0
Returns
the file or
null
if no more files are available
Exceptions
IOExceptionif an error occurs

Implements net.sf.gridarta.model.configsource.ConfigSource.

Definition at line 54 of file AbstractConfigSource.java.

References net.sf.gridarta.model.configsource.AbstractConfigSource.ACTION_BUILDER, net.sf.gridarta.utils.StringParameterBuilder.addParameter(), net.sf.gridarta.utils.IOUtils.getFile(), net.sf.gridarta.model.configsource.ConfigSource.getName(), and net.sf.gridarta.utils.StringParameterBuilder.replace().

+ Here is the call graph for this function:

◆ toString()

String net.sf.gridarta.model.configsource.AbstractConfigSource.toString ( )

Member Data Documentation

◆ ACTION_BUILDER

final ActionBuilder net.sf.gridarta.model.configsource.AbstractConfigSource.ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
staticprivate

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