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

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,FreeColModFile>	allMods A cache of all the mods.
private static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
Mods()

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<FreeColModFile>	getAllMods() Gets all available mods.
static FreeColModFile	getFreeColModFile(java.lang.String id) Get a mod by id.
static FreeColModFile	getModFile(java.lang.String id) Gets the mod with the given object identifier.
static java.util.List<FreeColTcFile>	getRuleSets() Gets all available rulesets.
private static void	loadModDirectory(java.io.File directory) Loads all valid mods from a specified directory.
static void	loadMods() Require all mods to be loaded.

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

A cache of all the mods.

Constructor Detail

Mods

public Mods()

Method Detail

loadModDirectory

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

Loads all valid mods from a specified directory.

Parameters:

directory - The directory to load from.

loadMods

public static void loadMods()

Require all mods to be loaded. This must be delayed until the mods directories are defined. User mods are loaded after standard mods to allow user override.

getModFile

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

Gets the mod with the given object identifier.

Parameters:

id - The identifier of the mod to search for.

Returns:

The FreeColModFile for the mod, or null if not found.

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.

getFreeColModFile

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

Get a mod by id.

Parameters:

id - The mod file identifier to look for.

Returns:

The FreeColModFile found, or null if none present.

getRuleSets

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

Gets all available rulesets.

Returns:

A list of FreeColModFiles containing rulesets.