com.force.i18n.commons.util.settings

Class AbstractNonConfigIniFile

java.lang.Object

com.force.i18n.commons.util.settings.AbstractNonConfigIniFile

All Implemented Interfaces:

BaseNonConfigIniFile, NonConfigIniFile

Direct Known Subclasses:

SimpleNonConfigIniFile

public abstract class AbstractNonConfigIniFile
extends Object
implements NonConfigIniFile

Simple implementation of the type conversion for an IniFile.

Author:

koliver

Constructor Summary

Constructors

Constructor and Description
AbstractNonConfigIniFile()

Method Summary

Modifier and Type	Method and Description
abstract Set<Map.Entry<String,Map<String,Object>>>	entrySet()
boolean	getBoolean(String section, String param) Get the value stored in section/param in the IniFile as a boolean.
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) Gets the value stored in the section/param as a float.
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) Get the value stored in section/param in the IniFile as an int.
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) Get a list of values stored in section/param in the IniFile.
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) Get the value stored in section/param in the IniFile as a string.
String	getString(String section, String param, String ifNull) Get the value stored in section/param in the IniFile as a string.
String	getStringThrow(String section, String param) Get the value stored in section/param in the IniFile as a string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.force.i18n.commons.util.settings.NonConfigIniFile

get, getSection

Methods inherited from interface com.force.i18n.commons.util.settings.BaseNonConfigIniFile

get

Constructor Detail

AbstractNonConfigIniFile

public AbstractNonConfigIniFile()

Method Detail

getList

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

Description copied from interface: NonConfigIniFile

Get a list of values stored in section/param in the IniFile. Will return an empty list if no object was found.

Specified by:

getList in interface NonConfigIniFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the list, possibly empty.

getList

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

Description copied from interface: BaseNonConfigIniFile

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

Specified by:

getList in interface BaseNonConfigIniFile

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

public boolean getBoolean(String section,
                          String param)

Description copied from interface: NonConfigIniFile

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

Specified by:

getBoolean in interface NonConfigIniFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

if the param was found, then: returns true if the text matches any of the true condition or false otherwise. If no param was found, then an exception will potentially be thrown.

getBoolean

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

Description copied from interface: BaseNonConfigIniFile

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

Specified by:

getBoolean in interface BaseNonConfigIniFile

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

public float getFloat(String section,
                      String param)

Description copied from interface: NonConfigIniFile

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

Specified by:

getFloat in interface NonConfigIniFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the float value

getFloat

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

Description copied from interface: BaseNonConfigIniFile

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

Specified by:

getFloat in interface BaseNonConfigIniFile

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

public int getInt(String section,
                  String param)

Description copied from interface: NonConfigIniFile

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

Specified by:

getInt in interface NonConfigIniFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the integer value from the section/param

getInt

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

Description copied from interface: BaseNonConfigIniFile

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

Specified by:

getInt in interface BaseNonConfigIniFile

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

getString

public String getString(String section,
                        String param)

Description copied from interface: NonConfigIniFile

Get the value stored in section/param in the IniFile as a string. Will return null if it was not found.

Specified by:

getString in interface NonConfigIniFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

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

getCensoredString

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

Description copied from interface: BaseNonConfigIniFile

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

Specified by:

getCensoredString in interface BaseNonConfigIniFile

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

getStringThrow

public String getStringThrow(String section,
                             String param)

Description copied from interface: NonConfigIniFile

Get the value stored in section/param in the IniFile as a string. Will throw exception if not found

Specified by:

getStringThrow in interface NonConfigIniFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

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

getString

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

Description copied from interface: BaseNonConfigIniFile

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

Specified by:

getString in interface BaseNonConfigIniFile

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

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

Specified by:

entrySet in interface BaseNonConfigIniFile

Returns:

all the values stored in all the section.