net.sf.freecol.common.io
Class Mods

java.lang.Object
  net.sf.freecol.common.io.Mods

public class Mods
extends java.lang.Object

Contains methods for getting a list of available mods.

Field Summary

private static java.util.Map<java.lang.String,FreeColModFile>	allMods
private static java.util.logging.Logger	logger
static java.io.FileFilter	MOD_FILTER

Constructor Summary

Mods()

Method Summary

static java.util.Collection<FreeColModFile>	getAllMods() Gets all available mods.
private static void	getDirectoryMods(java.io.File directory) Loads all valid mods from a specified directory.
static FreeColModFile	getModFile(java.io.File file) Gets a mod file from a file (possibly a directory).
static FreeColModFile	getModFile(java.lang.String id) Returns the FreeColModFile with the given ID.
static java.util.List<FreeColTcFile>	getRuleSets() Gets all available rules.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

allMods

private static final java.util.Map<java.lang.String,FreeColModFile> allMods

MOD_FILTER

public static final java.io.FileFilter MOD_FILTER

Constructor Detail

Mods

public Mods()

Method Detail

getModFile

public static FreeColModFile getModFile(java.io.File file)

Gets a mod file from a file (possibly a directory).

Parameters:

file - The File to test.

Returns:

A FreeColModFile if the file contains a mod, or null if it did not.

getModFile

public static FreeColModFile getModFile(java.lang.String id)

Returns the FreeColModFile with the given ID.

Parameters:

id - a String value

Returns:

a FreeColModFile value

getDirectoryMods

private static void getDirectoryMods(java.io.File directory)

Loads all valid mods from a specified directory.

Parameters:

directory - The directory to load from.

getAllMods

public static java.util.Collection<FreeColModFile> getAllMods()

Gets all available mods. User mods before standard mods to allow user override.

Returns:

A list of FreeColModFiles contain mods.

getRuleSets

public static java.util.List<FreeColTcFile> getRuleSets()

Gets all available rules.

Returns:

A list of FreeColModFiles contain mods.