com.force.i18n.commons.util.settings

Interface BaseNonConfigIniFile

All Known Subinterfaces:

GrammaticalLabelSet, GrammaticalLabelSet.GrammaticalLabelSetComposite, LabelSet, NonConfigIniFile, SharedLabelSet

All Known Implementing Classes:

AbstractNonConfigIniFile, BasePropertyFile, GrammaticalLabelSetFallbackImpl, GrammaticalLabelSetImpl, LabelSetImpl, SimpleNonConfigIniFile

public interface BaseNonConfigIniFile

A facade interface to pull out the methods from IniFile which will not throw any unchecked LabelNotFound or SectionNotFound exceptions. This facade is useful as there are some classes in Platform project which need to access some basic IniFile functionality.

Author:

http://BenjaminTsai.com/

Method Summary

Modifier and Type	Method and Description
Set<Map.Entry<String,Map<String,Object>>>	entrySet()
Object	get(String section, String param, Object ifNull) Get the object stored in section/param in the IniFile.
boolean	getBoolean(String section, String param, boolean ifNull) Get the value stored in section/param in the IniFile as a boolean.
String	getCensoredString(String section, String param, String ifNull) Get the value stored in section/param in the IniFile as a string - may censor the value if necessary.
float	getFloat(String section, String param, float ifNull) Gets the value stored in the section/param in the IniFile as a float
int	getInt(String section, String param, int ifNull) Get the value stored in section/param in the IniFile as an int.
List<String>	getList(String section, String param, List<String> ifNull) Get the list of values stored in section/param in the IniFile.
String	getString(String section, String param, String ifNull) Get the value stored in section/param in the IniFile as a string.

Method Detail

get

Object get(String section,
           String param,
           Object ifNull)

Get the object stored in section/param in the IniFile.

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the object to return if no value was found.

Returns:

the object, or ifNull if none was found.

getList

List<String> getList(String section,
                     String param,
                     List<String> ifNull)

Get the list of values stored in section/param in the IniFile.

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the list to return if no list was found.

Returns:

the list, or ifNull if the list was empty or null.

getBoolean

boolean getBoolean(String section,
                   String param,
                   boolean ifNull)

Get the value stored in section/param in the IniFile as a boolean.

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the boolean to default to.

Returns:

the boolean value that was found, or ifNull if none was found.

getFloat

float getFloat(String section,
               String param,
               float ifNull)

Gets the value stored in the section/param in the IniFile as a float

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the float to default to

Returns:

the float value that was found, or ifNull if none was found

getInt

int getInt(String section,
           String param,
           int ifNull)

Get the value stored in section/param in the IniFile as an int.

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the int to default to.

Returns:

the integer value from the section/param, or ifNull if it was not found

getCensoredString

String getCensoredString(String section,
                         String param,
                         String ifNull)

Get the value stored in section/param in the IniFile as a string - may censor the value if necessary.

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the default value to use.

Returns:

the String value of the given section/param, or ifNull, or something else if should be censored

getString

String getString(String section,
                 String param,
                 String ifNull)

Get the value stored in section/param in the IniFile as a string.

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the default value to use.

Returns:

the String value of the given section/param, or ifNull.

entrySet

Set<Map.Entry<String,Map<String,Object>>> entrySet()

Returns:

all the values stored in all the section.