Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface LanguageLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

DirtyLanguage

public interface LanguageLibrary
extends CMLibrary

The localization library for CoffeeMud works by building a set of property files that do string matching and replacement from all of the game strings that start with L().

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the cache of both the translator and the parser, allowing it all to be reloaded from the properties files on the filesystem.
java.lang.String	commandWordTranslation(java.lang.String str)	This unique translator is mostly run at boot time to translate the cached command words of commands, abilities, and similar things to the localized term.
java.lang.String	failedItemParser(java.lang.String item)	When a command or some other process is requesting access to a room or inventory item by name, and the entry from the user fails to find the item, this filter will be called to provide a "second chance" item name.
java.lang.String	filterTranslation(java.lang.String item)	The filter translation is an output translation that only handles pronoun tags, like S-NAME, T-YOUPOSS, etc.
java.lang.String	finalTranslation(java.lang.String item)	After an output string has gone through all the other processes, if there are any other translations to be done, this will handle it.
java.lang.String	fullSessionTranslation(java.lang.String str, java.lang.String... xs)	This is the main output and variable translator.
java.util.List<java.util.List<java.lang.String>>	preCommandParser(java.util.List<java.lang.String> CMDS)	Accepts user-entered pre-parsed command list, and generates a list containing one or more translated full command lists.
java.lang.String	preItemParser(java.lang.String item)	When a command or some other process is requesting access to a room or inventory item by name, or sometimes and exit, then this parser is called with the user input to translate things into a final search string.
java.lang.String	rawInputParser(java.lang.String words)	During login or other input that does not involve commands, this input parser can translate input.
java.lang.String	sessionTranslation(java.lang.String item)	A translator for static internal string, such as those found on interfaces.
java.lang.String[]	sessionTranslation(java.lang.String[] str)	A translator for static internal string arrays, such as those found on interfaces.
void	setLocale(java.lang.String lang, java.lang.String state)	Initializes the localization library by setting the language and state code, thus pointing the mud at which translation properties files to use.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

clear

void clear()

Clears the cache of both the translator and the parser, allowing it all to be reloaded from the properties files on the filesystem.

finalTranslation

java.lang.String finalTranslation(java.lang.String item)

After an output string has gone through all the other processes, if there are any other translations to be done, this will handle it. This is called immediately before an entire block of text is sent to the user.

Parameters:

item - the string to send to the user

Returns:

null, or a new string to send to the user

sessionTranslation

java.lang.String sessionTranslation(java.lang.String item)

A translator for static internal string, such as those found on interfaces. How this manages to set the locale before a lot of those strings get loaded by Java is probably a problem.

Parameters:

item - the static string

Returns:

the translated static string

sessionTranslation

java.lang.String[] sessionTranslation(java.lang.String[] str)

A translator for static internal string arrays, such as those found on interfaces. How this manages to set the locale before a lot of those classes get loaded by Java is probably a problem.

Parameters:

str - the static string array

Returns:

the translated static string array

fullSessionTranslation

java.lang.String fullSessionTranslation(java.lang.String str,
                                        java.lang.String... xs)

This is the main output and variable translator. Most internal system strings go through this method for localization. This also handles the @x1 @x2, ... variable replacements.

Parameters:

str - the variable-laden english system string

xs - variable values, NOT translated

Returns:

the full translated and variable-replaced string

filterTranslation

java.lang.String filterTranslation(java.lang.String item)

The filter translation is an output translation that only handles pronoun tags, like S-NAME, T-YOUPOSS, etc. After the engine generates the proper english replacement (usually a mob or object name), then this filter is given a pass as it to localize the output.

Parameters:

item - ONLY the replacement from a tag

Returns:

null, or the localized replacement string

setLocale

void setLocale(java.lang.String lang,
               java.lang.String state)

Initializes the localization library by setting the language and state code, thus pointing the mud at which translation properties files to use.

Parameters:

lang - the language code, default en

state - the state code, default TX

preCommandParser

java.util.List<java.util.List<java.lang.String>> preCommandParser(java.util.List<java.lang.String> CMDS)

Accepts user-entered pre-parsed command list, and generates a list containing one or more translated full command lists. This is called whenever the user enters a command at the main prompt.

Parameters:

CMDS - the pre-parsed command list

Returns:

a list with the translated command list

commandWordTranslation

java.lang.String commandWordTranslation(java.lang.String str)

This unique translator is mostly run at boot time to translate the cached command words of commands, abilities, and similar things to the localized term. Most input translators take a localized term to generate an english word the system can process, whereas this does the reverse: translate english into the localized language so that the user can match that term directly.

Parameters:

str - a single command word

Returns:

the given word, or the translated word

preItemParser

java.lang.String preItemParser(java.lang.String item)

When a command or some other process is requesting access to a room or inventory item by name, or sometimes and exit, then this parser is called with the user input to translate things into a final search string.

Parameters:

item - the user entered item name

Returns:

null to use the users word, or the new translated string

failedItemParser

java.lang.String failedItemParser(java.lang.String item)

When a command or some other process is requesting access to a room or inventory item by name, and the entry from the user fails to find the item, this filter will be called to provide a "second chance" item name. Or null to skip the second chance.

Parameters:

item - the user entered item name

Returns:

null, or a substitute item name to try

rawInputParser

java.lang.String rawInputParser(java.lang.String words)

During login or other input that does not involve commands, this input parser can translate input.

Parameters:

words - the input

Returns:

the new input