Package net.sf.gridarta.model.configsource

Interface ConfigSource

All Known Implementing Classes:

AbstractConfigSource, CollectedConfigSource, CollectedConfigSource, CollectedConfigSource, FilesConfigSource, FilesConfigSource, FilesConfigSource

public interface ConfigSource

Possible source locations for configuration files.

Method Summary

Modifier and Type	Method	Description
@Nullable java.io.File	getFile(@NotNull ProjectSettings projectSettings, @NotNull java.lang.String type, int index)	Returns a config file.
@NotNull java.lang.String	getName()	Returns the internal name.
boolean	isArchDirectoryInputFieldEnabled()	Whether the "archetype directory" input field in the settings dialog should be enabled.
<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>> void	read(@NotNull ProjectSettings projectSettings, @NotNull AbstractResources<G,A,R> resources, @NotNull ErrorView errorView)	Reads config files.
@NotNull java.lang.String	toString()

Method Detail

getName

@NotNull
@NotNull java.lang.String getName()

Returns the internal name.

Returns:

the internal name

toString

@NotNull
@NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

read

<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>> void read(@NotNull
                                                                                                                                  @NotNull ProjectSettings projectSettings,
                                                                                                                                  @NotNull
                                                                                                                                  @NotNull AbstractResources<G,A,R> resources,
                                                                                                                                  @NotNull
                                                                                                                                  @NotNull ErrorView errorView)

Reads config files.

Parameters:

projectSettings - the project settings to use

resources - the resources to update

errorView - the error view for reporting errors

isArchDirectoryInputFieldEnabled

boolean isArchDirectoryInputFieldEnabled()

Whether the "archetype directory" input field in the settings dialog should be enabled.

Returns:

whether the input field should be enabled

getFile

@Nullable
@Nullable java.io.File getFile(@NotNull
                               @NotNull ProjectSettings projectSettings,
                               @NotNull
                               @NotNull java.lang.String type,
                               int index)
                        throws java.io.IOException

Returns a config file.

Parameters:

projectSettings - the project settings to use

type - the file type

index - the file index, starting with 0

Returns:

the file or null if no more files are available

Throws:

java.io.IOException - if an error occurs