com.force.i18n.settings

Class BasePropertyFile

java.lang.Object

com.force.i18n.settings.BasePropertyFile

All Implemented Interfaces:

BaseNonConfigIniFile, Serializable

Direct Known Subclasses:

LabelSetImpl

public class BasePropertyFile
extends Object
implements BaseNonConfigIniFile, Serializable

This class parses XML configuration files and puts the data into a data structure that can be used by the app to retrieve info.

Comments can be entered using standard XML comment syntax.

References

<Value>s may contain substitutions of other <ParamName>,<Value> pairs. Substitutions are indicated by strings of the form: When the parser sees such strings, they are replaced with the selected <SectionName>.<ParamName> pair. References are in the form ${<section>.<param>}

Forward and multi-level references are allowed, but circular are not.

Values may also contain references to system parameters.

Example

                                     <section name="sectionName">

                                         <!--  Standard Parameter -->
                                         <param name="paramName1"> paramValue </param>

                                         <!--  Parameter Reference -->
                                         <param name="paramName2"> ${sectionName.paramName1} </param>

                                         <!--  Property Reference -->
                                         <param name="paramName3"> #{user.property} </param>

                                     </section>
 

Author:

nveeser, btsai

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasePropertyFile.MetaDataInfo
static interface	BasePropertyFile.Parser Interface used by PropertyFile and its subclasses to parse and load its internal map data structure (eg.
static class	BasePropertyFile.SubstitutionException

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyFileData	data
protected long	lastModified
protected Map<String,Map<String,BasePropertyFile.MetaDataInfo>>	metaData
static String	MISSING_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
	BasePropertyFile()
	BasePropertyFile(BasePropertyFile.Parser p)
protected	BasePropertyFile(BasePropertyFile.Parser p, PropertyFileData data)
	BasePropertyFile(int initialCapacity)
protected	BasePropertyFile(int initialCapacity, PropertyFileData data)
protected	BasePropertyFile(PropertyFileData data)

Method Summary

Modifier and Type	Method and Description
void	attachSharedKeyMap(SharedKeyMap<String,SharedKeyMap<String,Object>> seedKeyMap) Allows for some implementations to save a great deal of memory by sharing maps across various language versions of the "same" properties/labels.
boolean	containsListParam(String section, String baseParam) Whether the section contains an enum list with the baseParam.
boolean	containsParam(String section, String param)
boolean	containsSection(String section)
void	doSubstitutions()
void	doSubstitutions(Object referenceConfig)
Set<Map.Entry<String,Map<String,Object>>>	entrySet()
Object	get(String section, String param) Get the value for a given SectName.ParamName pair.
Object	get(String section, String param, boolean allowLabelException)
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	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) Censors the value before returning it to the caller.
float	getFloat(String section, String param)
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	getInt(String section, String param, int ifNull) Get the value stored in section/param in the IniFile as an int.
long	getLastModified()
List<String>	getList(String section, String baseParam) Gets all values of parameters that begin with baseParam_xx, where xx is a number starting from 0.
List<String>	getList(String section, String baseParam, List<String> ifNull) Gets all values of parameters that begin with baseParam_xx, where xx is a number starting from 0.
List<String>	getListConfigValues(String section) Gets all values of parameters that were in the section for a build config file
int	getNumListEntryParams(String section, String baseParam) Get the number of enumItems within an enum list param.
Set<String>	getParams(String section)
Set<String>	getParams(String section, Set<String> ifNull)
protected PropertyFileData	getPropertyFileData()
Map<String,Object>	getSection(String sectionName) Returns an unmodifiable Map of all the values for a particular sectionName.
String	getString(String section, String param)
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)
protected Object	inner_get(String section, String param, boolean throwSettingsSectionNotFoundException)
boolean	isProductionMode()
static String	makeListEntryParam(String baseParam, int index)
protected void	outputValueXML(Object value, OutputStreamWriter os)
protected void	outputValueXMLCensored(OutputStreamWriter os, String sectionName, String paramName, Object value)
void	outputXML(OutputStream os) Output XML data to a stream output is for set.dtd.
void	outputXML(OutputStream os, boolean doCensor) Outputs XML data to a stream output, either censored or uncensored version depending on doCensor's value.
Object	put(String section, String param, Object value)
void	remove(String sectionName, String paramName)
void	removeSection(String sectionName)
Set<String>	sectionNames()
void	setLastModified(long lastModified)
static boolean	stringToBoolean(String booleanValue) Defaults to false if the string does not match one of the following - 1 - true - yes - on
protected Object	substitute(String sectionName, String paramName, Object val, Object referenceConfig) Allow child implementations to substitute values based on an external set of params

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_LABEL

public static final String MISSING_LABEL

data

protected PropertyFileData data

metaData

protected final Map<String,Map<String,BasePropertyFile.MetaDataInfo>> metaData

lastModified

protected long lastModified

Constructor Detail

BasePropertyFile

public BasePropertyFile(int initialCapacity)

BasePropertyFile

public BasePropertyFile()

BasePropertyFile

protected BasePropertyFile(PropertyFileData data)

BasePropertyFile

protected BasePropertyFile(int initialCapacity,
                           PropertyFileData data)

BasePropertyFile

public BasePropertyFile(BasePropertyFile.Parser p)
                 throws IOException

Throws:

IOException

BasePropertyFile

protected BasePropertyFile(BasePropertyFile.Parser p,
                           PropertyFileData data)
                    throws IOException

Throws:

IOException

Method Detail

entrySet

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

Specified by:

entrySet in interface BaseNonConfigIniFile

Returns:

all the values stored in all the section.

sectionNames

public Set<String> sectionNames()

remove

public void remove(String sectionName,
                   String paramName)

removeSection

public void removeSection(String sectionName)

containsSection

public boolean containsSection(String section)

containsParam

public boolean containsParam(String section,
                             String param)

containsListParam

public boolean containsListParam(String section,
                                 String baseParam)

Whether the section contains an enum list with the baseParam.

getListConfigValues

public List<String> getListConfigValues(String section)
                                 throws SettingsSectionNotFoundException

Gets all values of parameters that were in the section for a build config file

Throws:

SettingsSectionNotFoundException

getList

public List<String> getList(String section,
                            String baseParam)
                     throws SettingsSectionNotFoundException

Gets all values of parameters that begin with baseParam_xx, where xx is a number starting from 0.

Throws:

SettingsSectionNotFoundException

getList

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

Gets all values of parameters that begin with baseParam_xx, where xx is a number starting from 0.

Specified by:

getList in interface BaseNonConfigIniFile

Parameters:

section - the section to look in.

baseParam - 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.

getNumListEntryParams

public int getNumListEntryParams(String section,
                                 String baseParam)

Get the number of enumItems within an enum list param.

makeListEntryParam

public static String makeListEntryParam(String baseParam,
                                        int index)

getParams

public Set<String> getParams(String section)
                      throws SettingsSectionNotFoundException

Returns:

a set of all params in the specified section. You'd best be not messing with it.

Throws:

SettingsSectionNotFoundException

inner_get

protected Object inner_get(String section,
                           String param,
                           boolean throwSettingsSectionNotFoundException)
                    throws SettingsSectionNotFoundException

Throws:

SettingsSectionNotFoundException

getParams

public Set<String> getParams(String section,
                             Set<String> ifNull)

Returns:

a set of all params in the specified section. You'd best be not messing with it.

get

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

Description copied from interface: BaseNonConfigIniFile

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

Specified by:

get in interface BaseNonConfigIniFile

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.

get

public Object get(String section,
                  String param,
                  boolean allowLabelException)
           throws ParameterNotFoundException,
                  SettingsSectionNotFoundException

Throws:

ParameterNotFoundException

SettingsSectionNotFoundException

get

public Object get(String section,
                  String param)
           throws ParameterNotFoundException,
                  SettingsSectionNotFoundException

Get the value for a given SectName.ParamName pair.

Parameters:

section - the section name of the desired variable

param - the parameter name with the the given section

Returns:

the value of the parameter

Throws:

ParameterNotFoundException

SettingsSectionNotFoundException

getString

public String getString(String section,
                        String param)
                 throws ParameterNotFoundException,
                        SettingsSectionNotFoundException

Throws:

ParameterNotFoundException

SettingsSectionNotFoundException

getStringThrow

public String getStringThrow(String section,
                             String param)
                      throws ParameterNotFoundException,
                             SettingsSectionNotFoundException

Throws:

ParameterNotFoundException

SettingsSectionNotFoundException

getCensoredString

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

Censors the value before returning it to the caller. However, if the value is null, then we will not run the censoring logic and just return the passed in ifNull value directly. Note: Do _NOT_ rely the censored value we return always being the same. The exact censored output may change over time.

Specified by:

getCensoredString in interface BaseNonConfigIniFile

Parameters:

section - the section for the label

param - the key for the label

ifNull - default value to return if null (not set).

Returns:

some number of 'x'ses if the value should be censored.

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.

getInt

public int getInt(String section,
                  String param)
           throws ParameterNotFoundException,
                  SettingsSectionNotFoundException

Throws:

ParameterNotFoundException

SettingsSectionNotFoundException

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

getFloat

public float getFloat(String section,
                      String param)
               throws SettingsSectionNotFoundException,
                      ParameterNotFoundException

Throws:

SettingsSectionNotFoundException

ParameterNotFoundException

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

getBoolean

public boolean getBoolean(String section,
                          String param)
                   throws ParameterNotFoundException,
                          SettingsSectionNotFoundException

Throws:

ParameterNotFoundException

SettingsSectionNotFoundException

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.

put

public Object put(String section,
                  String param,
                  Object value)

getSection

public Map<String,Object> getSection(String sectionName)

Returns an unmodifiable Map of all the values for a particular sectionName. If, that section does not exist, will return null.

outputXML

public void outputXML(OutputStream os)
               throws IOException

Output XML data to a stream output is for set.dtd. This will not give an exact copy of what was read in.

Throws:

IOException

outputXML

public void outputXML(OutputStream os,
                      boolean doCensor)
               throws IOException

Outputs XML data to a stream output, either censored or uncensored version depending on doCensor's value. Note: outputValueXML vs outputValueXMLCensored will go away in 152 when configuration is split out from labels / motifs.

Parameters:

os - the output stream to write to

doCensor - will censor values like password if set to true

Throws:

IOException

outputValueXML

protected void outputValueXML(Object value,
                              OutputStreamWriter os)
                       throws IOException

Throws:

IOException

outputValueXMLCensored

protected void outputValueXMLCensored(OutputStreamWriter os,
                                      String sectionName,
                                      String paramName,
                                      Object value)
                               throws IOException

Throws:

IOException

getLastModified

public final long getLastModified()

setLastModified

public final void setLastModified(long lastModified)

doSubstitutions

public void doSubstitutions()
                     throws ParameterNotFoundException,
                            IOException

Throws:

ParameterNotFoundException

IOException

doSubstitutions

public void doSubstitutions(Object referenceConfig)
                     throws ParameterNotFoundException,
                            IOException

Throws:

ParameterNotFoundException

IOException

substitute

protected Object substitute(String sectionName,
                            String paramName,
                            Object val,
                            Object referenceConfig)
                     throws IOException,
                            BasePropertyFile.SubstitutionException

Allow child implementations to substitute values based on an external set of params

Parameters:

sectionName - the section of the param being replace

paramName - the key of the param being replace

val - the value being replaced

referenceConfig - an object being passed in to parsing for

Returns:

the val with substrings substituted if need be

Throws:

IOException - in case there are any IO Exceptions

BasePropertyFile.SubstitutionException - in case the val has a malformed section/param

getPropertyFileData

protected PropertyFileData getPropertyFileData()

attachSharedKeyMap

public void attachSharedKeyMap(SharedKeyMap<String,SharedKeyMap<String,Object>> seedKeyMap)

Allows for some implementations to save a great deal of memory by sharing maps across various language versions of the "same" properties/labels.

isProductionMode

public boolean isProductionMode()

stringToBoolean

public static boolean stringToBoolean(String booleanValue)

Defaults to false if the string does not match one of the following - 1 - true - yes - on