An ProjectSettings implementation for testing purposes. More...

Inheritance diagram for net.sf.gridarta.model.settings.TestProjectSettings:

Collaboration diagram for net.sf.gridarta.model.settings.TestProjectSettings:

Public Member Functions
File	getArchDirectory ()
	Returns the archetype directory. More...

File	getCollectedDirectory ()
	Returns the directory where collected archetypes are stored. More...

String	getConfigSourceName ()
	Returns the name of the configuration source. More...

File	getConfigurationDirectory ()
	Returns the configuration directory which is used to load configuration information like types.xml. More...

String	getImageSet ()
	Returns the image set. More...

File	getMapsDirectory ()
	Returns the default maps directory. More...

File	getMediaDirectory ()
	Returns the media directory. More...

File	getPickmapDir ()
	Returns the pickmap directory. More...

String	getUserName ()
	Returns the user name. More...

boolean	saveIndices ()
	Returns whether indices should be saved to disk. More...

void	setArchDirectory (@NotNull final File archDirectory)
	Sets the archetype directory. More...

void	setConfigSourceName (@NotNull final String configSourceName)
	Sets the name of the configuration source. More...

void	setImageSet (@NotNull final String imageSet)
	Sets the image set. More...

void	setMapsDirectory (@NotNull final File mapsDirectory)
	Sets the default maps directory. More...

void	setMediaDirectory (@NotNull final File mediaDirectory)
	Sets the media directory. More...

void	setUserName (@NotNull final String userName)
	Sets the user name. More...

Public Member Functions inherited from net.sf.gridarta.model.settings.AbstractProjectSettings
void	addProjectSettingsListener (@NotNull final ProjectSettingsListener listener)
	Adds a ProjectSettingsListener to be notified of changes. More...

void	removeProjectSettingsListener (@NotNull final ProjectSettingsListener listener)
	Removes a ProjectSettingsListener to be notified of changes. More...

Private Attributes
File	mapsDirectory = new File("maps")
	The maps directory. More...

Additional Inherited Members
Protected Member Functions inherited from net.sf.gridarta.model.settings.AbstractProjectSettings
void	fireMapsDirectoryChanged ()
	Notifies all listeners about a changed maps directory. More...

Detailed Description

An ProjectSettings implementation for testing purposes.

Author: Andreas Kirschbaum

Definition at line 29 of file TestProjectSettings.java.

Member Function Documentation

◆ getArchDirectory()

File net.sf.gridarta.model.settings.TestProjectSettings.getArchDirectory ( )

Returns the archetype directory.

Returns: the archetype directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 39 of file TestProjectSettings.java.

◆ getCollectedDirectory()

File net.sf.gridarta.model.settings.TestProjectSettings.getCollectedDirectory ( )

Returns the directory where collected archetypes are stored.

Returns: the directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 111 of file TestProjectSettings.java.

◆ getConfigSourceName()

String net.sf.gridarta.model.settings.TestProjectSettings.getConfigSourceName ( )

Returns the name of the configuration source.

Returns: the name of the configuration source

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 66 of file TestProjectSettings.java.

◆ getConfigurationDirectory()

File net.sf.gridarta.model.settings.TestProjectSettings.getConfigurationDirectory ( )

Returns the configuration directory which is used to load configuration information like types.xml.

Returns: the directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 105 of file TestProjectSettings.java.

◆ getImageSet()

String net.sf.gridarta.model.settings.TestProjectSettings.getImageSet ( )

Returns the image set.

Returns: the image set

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 94 of file TestProjectSettings.java.

◆ getMapsDirectory()

File net.sf.gridarta.model.settings.TestProjectSettings.getMapsDirectory ( )

Returns the default maps directory.

Returns: the default maps directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 50 of file TestProjectSettings.java.

References net.sf.gridarta.model.settings.TestProjectSettings.mapsDirectory.

◆ getMediaDirectory()

File net.sf.gridarta.model.settings.TestProjectSettings.getMediaDirectory ( )

Returns the media directory.

It contains background music files.

Returns: the media directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 83 of file TestProjectSettings.java.

◆ getPickmapDir()

File net.sf.gridarta.model.settings.TestProjectSettings.getPickmapDir ( )

Returns the pickmap directory.

Returns: the pickmap directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 77 of file TestProjectSettings.java.

◆ getUserName()

String net.sf.gridarta.model.settings.TestProjectSettings.getUserName ( )

Returns the user name.

Returns: the user name

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 117 of file TestProjectSettings.java.

◆ saveIndices()

boolean net.sf.gridarta.model.settings.TestProjectSettings.saveIndices ( )

Returns whether indices should be saved to disk.

Returns: whether indices should be saved to disk

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 127 of file TestProjectSettings.java.

◆ setArchDirectory()

void net.sf.gridarta.model.settings.TestProjectSettings.setArchDirectory ( @NotNull final File archDirectory )

Sets the archetype directory.

Parameters

archDirectory the archetype directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 44 of file TestProjectSettings.java.

◆ setConfigSourceName()

void net.sf.gridarta.model.settings.TestProjectSettings.setConfigSourceName ( @NotNull final String configSourceName )

Sets the name of the configuration source.

Parameters

configSourceName the name

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 71 of file TestProjectSettings.java.

◆ setImageSet()

void net.sf.gridarta.model.settings.TestProjectSettings.setImageSet ( @NotNull final String imageSet )

Sets the image set.

Parameters

imageSet the image set

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 99 of file TestProjectSettings.java.

◆ setMapsDirectory()

void net.sf.gridarta.model.settings.TestProjectSettings.setMapsDirectory ( @NotNull final File mapsDirectory )

Sets the default maps directory.

Parameters

mapsDirectory the default maps directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 55 of file TestProjectSettings.java.

References net.sf.gridarta.model.settings.AbstractProjectSettings.fireMapsDirectoryChanged(), and net.sf.gridarta.model.settings.TestProjectSettings.mapsDirectory.

Here is the call graph for this function:

◆ setMediaDirectory()

void net.sf.gridarta.model.settings.TestProjectSettings.setMediaDirectory ( @NotNull final File mediaDirectory )

Sets the media directory.

It contains background music files.

Parameters

mediaDirectory the media directory

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 88 of file TestProjectSettings.java.

◆ setUserName()

void net.sf.gridarta.model.settings.TestProjectSettings.setUserName ( @NotNull final String userName )

Sets the user name.

Parameters

userName the user name

Implements net.sf.gridarta.model.settings.ProjectSettings.

Definition at line 122 of file TestProjectSettings.java.

Member Data Documentation

◆ mapsDirectory

File net.sf.gridarta.model.settings.TestProjectSettings.mapsDirectory = new File("maps")

private

The maps directory.

Definition at line 35 of file TestProjectSettings.java.

Referenced by net.sf.gridarta.model.settings.TestProjectSettings.getMapsDirectory(), and net.sf.gridarta.model.settings.TestProjectSettings.setMapsDirectory().

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

gridarta-gridarta/src/model/src/test/java/net/sf/gridarta/model/settings/TestProjectSettings.java

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getArchDirectory()

◆ getCollectedDirectory()

◆ getConfigSourceName()

◆ getConfigurationDirectory()

◆ getImageSet()

◆ getMapsDirectory()

◆ getMediaDirectory()

◆ getPickmapDir()

◆ getUserName()

◆ saveIndices()

◆ setArchDirectory()

◆ setConfigSourceName()

◆ setImageSet()

◆ setMapsDirectory()

◆ setMediaDirectory()

◆ setUserName()

Member Data Documentation

◆ mapsDirectory