com.force.i18n.commons.util.settings

Interface NonConfigIniFile

All Superinterfaces:

BaseNonConfigIniFile

All Known Subinterfaces:

GrammaticalLabelSet, GrammaticalLabelSet.GrammaticalLabelSetComposite, LabelSet, SharedLabelSet

All Known Implementing Classes:

AbstractNonConfigIniFile, GrammaticalLabelSetFallbackImpl, GrammaticalLabelSetImpl, LabelSetImpl, SimpleNonConfigIniFile

public interface NonConfigIniFile
extends BaseNonConfigIniFile

A generic IniFile interface, usable by shared code, and implemented by the IniFile on the app as well as the various IniFiles in shared.resource. Methods in here may throw unchecked LabelNotFoundException or SectionNotFoundExceptios.

Author:

smawson

Method Summary

Modifier and Type	Method and Description
Object	get(String section, String param) Get the object stored in section/param in the IniFile.
boolean	getBoolean(String section, String param) Get the value stored in section/param in the IniFile as a boolean.
float	getFloat(String section, String param) Gets the value stored in the section/param as a float.
int	getInt(String section, String param) 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.
Map<String,Object>	getSection(String section) Returns all the values stored in the section.
String	getString(String section, String param) 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 interface com.force.i18n.commons.util.settings.BaseNonConfigIniFile

entrySet, get, getBoolean, getCensoredString, getFloat, getInt, getList, getString

Method Detail

get

Object get(String section,
           String param)

Get the object stored in section/param in the IniFile. Will return null if no object was found.

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the object, or null if none was found.

getList

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

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

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the list, possibly empty.

getBoolean

boolean getBoolean(String section,
                   String param)

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.

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.

getFloat

float getFloat(String section,
               String param)

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

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the float value

getInt

int getInt(String section,
           String param)

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.

Returns:

the integer value from the section/param

Throws:

NumberFormatException - if the value wasn't a valid int.

getString

String getString(String section,
                 String param)

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

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.

getStringThrow

String getStringThrow(String section,
                      String param)

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

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.

getSection

Map<String,Object> getSection(String section)

Returns all the values stored in the section.

Parameters:

section - the section to return.

Returns:

A map of all the values in the section, or null if the section does not exist.