pl.isangeles.senlin.util

Class TConnector

java.lang.Object

pl.isangeles.senlin.util.TConnector

public final class TConnector
extends java.lang.Object

Static class giving access to external text files

Author:

Isangeles

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDialogueText(java.lang.String id) Returns dialogue text from current dialogues base
static java.lang.String[]	getInfo(java.lang.String langFile, java.lang.String id) Returns table with name[0] and info[1] for specified ID form specified lang file in data/lang directory
static java.lang.String[]	getInfoFromChapter(java.lang.String langFile, java.lang.String id) Returns table with name[0] and info[1] for specified ID from lang file in active chapter directory of current module
static java.lang.String[]	getInfoFromFile(java.lang.String filePath, java.lang.String id) Returns table with name[0] and info[1] for specified ID from specified file
static java.lang.String[]	getInfoFromModule(java.lang.String langFile, java.lang.String id) Returns table with name[0] and info[1] for specified ID from lang file in current module directory
static java.lang.String	getRanomText(java.lang.String category) Returns random text from "random" file in data/lang directory
static java.lang.String	getSetting(java.lang.String settingId) Returns setting with specified ID from settings file
static java.lang.String	getText(java.lang.String fileName, java.lang.String textID) Static method which searches specified text file in current lang directory and return string with specific id construction of text file: [text id]:[text];[new line mark]
static java.lang.String	getTextFromChapter(java.lang.String fileName, java.lang.String textID) Returns text with for specified ID from specified file in lang directory of active chapter in current module directory (data/modules/[current module name]/chapers/[current chapter name]/lang/[current lang name]/[file name]) construction of text file: [text id]:[text];[new line mark]
static java.lang.String	getTextFromFile(java.lang.String filePath, java.lang.String textID) Static method which searches specified text file and return string with specific id construction of text file: [text id]:[text];[new line mark]
static java.lang.String	getTextFromModule(java.lang.String fileName, java.lang.String textID) Returns text with for specified ID from specified file in current module lang directory (data/modules/[currentModuleName]/lang/[currentLangName]/[fileName]) construction of text file: [text id]:[text];[new line mark]
static java.util.List<java.lang.String>	getValues(java.lang.String filePath) Returns list with all values from file with specified path

Methods inherited from class java.lang.Object

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

Method Detail

getTextFromFile

public static java.lang.String getTextFromFile(java.lang.String filePath,
                                               java.lang.String textID)

Static method which searches specified text file and return string with specific id construction of text file: [text id]:[text];[new line mark]

Parameters:

filePath - Path to text file

textID - Id of text line

Returns:

String with text or error message

getValues

public static java.util.List<java.lang.String> getValues(java.lang.String filePath)

Returns list with all values from file with specified path

Parameters:

filePath - Path to text file

Returns:

List with string values

getText

public static java.lang.String getText(java.lang.String fileName,
                                       java.lang.String textID)

Static method which searches specified text file in current lang directory and return string with specific id construction of text file: [text id]:[text];[new line mark]

Parameters:

fileName - Name of the file in current lang directory

textID - Id of text line

Returns:

String with text or error message

getTextFromModule

public static java.lang.String getTextFromModule(java.lang.String fileName,
                                                 java.lang.String textID)

Returns text with for specified ID from specified file in current module lang directory (data/modules/[currentModuleName]/lang/[currentLangName]/[fileName]) construction of text file: [text id]:[text];[new line mark]

Parameters:

fileName - Name of the file in current lang directory

textID - Id of text line

Returns:

String with text or error message

getTextFromChapter

public static java.lang.String getTextFromChapter(java.lang.String fileName,
                                                  java.lang.String textID)

Returns text with for specified ID from specified file in lang directory of active chapter in current module directory (data/modules/[current module name]/chapers/[current chapter name]/lang/[current lang name]/[file name]) construction of text file: [text id]:[text];[new line mark]

Parameters:

fileName - Name of the file in current lang directory

textID - Id of text line

Returns:

String with text or error message

getInfo

public static java.lang.String[] getInfo(java.lang.String langFile,
                                         java.lang.String id)

Returns table with name[0] and info[1] for specified ID form specified lang file in data/lang directory

Parameters:

langFile - Some file in current lang directory

id - ID of line in specified file

Returns:

Table with name[0] and info[1]

getInfoFromFile

public static java.lang.String[] getInfoFromFile(java.lang.String filePath,
                                                 java.lang.String id)

Returns table with name[0] and info[1] for specified ID from specified file

Parameters:

filePath - Path to lang file

id - ID of line in specified file

Returns:

Table with name[0] and info[1]

getInfoFromModule

public static java.lang.String[] getInfoFromModule(java.lang.String langFile,
                                                   java.lang.String id)

Returns table with name[0] and info[1] for specified ID from lang file in current module directory

Parameters:

langFile - Some file in current lang directory

id - ID of line in specified file

Returns:

Table with name[0] and info[1]

getInfoFromChapter

public static java.lang.String[] getInfoFromChapter(java.lang.String langFile,
                                                    java.lang.String id)

Returns table with name[0] and info[1] for specified ID from lang file in active chapter directory of current module

Parameters:

langFile - Some file in current lang directory

id - ID of line in specified file

Returns:

Table with name[0] and info[1]

getRanomText

public static java.lang.String getRanomText(java.lang.String category)

Returns random text from "random" file in data/lang directory

Parameters:

category - One of categories in random file

Returns:

Random text from specified category in data/lang/[current language]/random file

getDialogueText

public static java.lang.String getDialogueText(java.lang.String id)

Returns dialogue text from current dialogues base

Parameters:

id - Id of text in lang file

Returns:

String with ID-corresponding text for current language

getSetting

public static java.lang.String getSetting(java.lang.String settingId)
                                   throws java.io.FileNotFoundException,
                                          java.util.NoSuchElementException

Returns setting with specified ID from settings file

Parameters:

settingId - Setting ID

Returns:

String with setting

Throws:

java.io.FileNotFoundException

java.util.NoSuchElementException