Package com.codinglitch.lexiconfig

Class LexiconfigApi

java.lang.Object

com.codinglitch.lexiconfig.LexiconfigApi

Direct Known Subclasses:

Lexiconfig

public abstract class LexiconfigApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LexiconfigApi.EventType	These are all the available event types for use inside the registerListener method.
static enum	LexiconfigApi.Extension	These are the possible extensions to save the config as.
static enum	LexiconfigApi.Location	These are the possible locations to store a lexicon at.

Field Summary

Fields

Modifier and Type	Field	Description
static LexiconfigApi	INSTANCE
static final List<Library>	LIBRARIES
protected static final Map<Consumer<LexiconEvent>,LexiconfigApi.EventType>	LISTENERS
protected static final List<LexiconData>	SHELVED_LEXICONS

Constructor Summary

Constructors

Constructor	Description
LexiconfigApi()

Method Summary

Modifier and Type	Method	Description
protected void	callEvent(LexiconfigApi.EventType eventType, LexiconEvent event)
static void	debug(Object object, Object... substitutions)
static void	error(Object object, Object... substitutions)
static Optional<Library>	findLibrary(String id)	Searches for a library with the matching mod ID.
abstract Path	getConfigPath(LexiconfigApi.Location location)	This is used to retrieve the configuration folder path, dependent on the modloader.
static void	info(Object object, Object... substitutions)
static <E extends LexiconEvent> void	registerListener(LexiconfigApi.EventType eventType, Consumer<E> listener)	This used to register a listener of a certain type, which is fired in various parts of the lifecycle.
static void	shelveLexicon(Library library, LexiconData lexicon)	This method is used to shelve a lexicon to be registered for reloading events, etc.
static void	warn(Object object, Object... substitutions)

Methods inherited from class java.lang.Object

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

Field Details

SHELVED_LEXICONS

protected static final List<LexiconData> SHELVED_LEXICONS

LISTENERS

protected static final Map<Consumer<LexiconEvent>,LexiconfigApi.EventType> LISTENERS

LIBRARIES

public static final List<Library> LIBRARIES

INSTANCE

public static LexiconfigApi INSTANCE

Constructor Details

LexiconfigApi

public LexiconfigApi()

Method Details

info

public static void info(Object object,
 Object... substitutions)

debug

public static void debug(Object object,
 Object... substitutions)

warn

public static void warn(Object object,
 Object... substitutions)

error

public static void error(Object object,
 Object... substitutions)

shelveLexicon

public static void shelveLexicon(Library library,
 LexiconData lexicon)

This method is used to shelve a lexicon to be registered for reloading events, etc. and should be called within the shelveLexicons method of a LexiconLibrary.

Parameters:

library - The library to shelve the lexicon in

lexicon - The lexicon to shelve

See Also:

• Library
• Library.shelveLexicons()

findLibrary

public static Optional<Library> findLibrary(String id)

Searches for a library with the matching mod ID.

Parameters:

id - The id of the mod to search for

Returns:

The library, if found

See Also:

• Library
• Library.shelveLexicons()

registerListener

public static <E extends LexiconEvent> void registerListener(LexiconfigApi.EventType eventType,
 Consumer<E> listener)

This used to register a listener of a certain type, which is fired in various parts of the lifecycle.

See Also:

• LexiconfigApi.EventType
• com.codinglitch.lexiconfig.events

callEvent

protected void callEvent(LexiconfigApi.EventType eventType,
 LexiconEvent event)

getConfigPath

public abstract Path getConfigPath(LexiconfigApi.Location location)

This is used to retrieve the configuration folder path, dependent on the modloader.

Returns:

The path of the config folder