com.force.i18n.grammar

Interface GrammaticalLabelSet

All Superinterfaces:

BaseNonConfigIniFile, LabelSet, NonConfigIniFile, Serializable, SharedLabelSet

All Known Subinterfaces:

GrammaticalLabelSet.GrammaticalLabelSetComposite

All Known Implementing Classes:

GrammaticalLabelSetFallbackImpl, GrammaticalLabelSetImpl

public interface GrammaticalLabelSet
extends LabelSet

Represents a label set that has a "grammar" to it, as opposed to a "normal" labelfile

Author:

stamm

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GrammaticalLabelSet.GrammaticalLabelSetComposite An interface that is a composite of two GrammaticalLabelSets, a fallback set for any values that are missing from an overlay set

Method Summary

Modifier and Type	Method and Description
Object	get(LabelReference reference)
Object	get(String section, String param, boolean allowLabelException)
LanguageDictionary	getDictionary()
GrammaticalTerm	getGrammaticalTerm(String section, String param) Test to see if the parameter contains *solely* a grammatical term, and if it does, return it, otherwise null
PropertyFileData	getPropertyFileData()
Set<String>	getPublicSectionNames()
String	getString(LabelReference reference)
String	getString(String section, Renameable[] entities, String param)
String	getString(String section, Renameable[] entities, String param, boolean forMessageFormat)
String	getString(String section, Renameable[] entities, String param, String ifNull)
String	getString(String section, String param, boolean forMessageFormat)

Methods inherited from interface com.force.i18n.LabelSet

containsParam, containsSection, getLabelSectionToFilename, getLastModified, getParams, getParams, sectionNames

Methods inherited from interface com.force.i18n.SharedLabelSet

labelExists

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

get, getBoolean, getFloat, getInt, getList, getSection, getString, getStringThrow

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

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

Method Detail

get

Object get(LabelReference reference)

Parameters:

reference - the label to look up

Returns:

the value contained in this label set at the given reference, or null if none was found

get

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

Parameters:

section - the section to search

param - the key inside that section

allowLabelException - if an exception should be thrown instead of null returned for a bad label

Returns:

the value in the label set for the given section and param, throwing an exception depending on the boolean value

Throws:

ParameterNotFoundException - if the parameter is missing

SettingsSectionNotFoundException - if the section is undefined

getString

String getString(LabelReference reference)

Parameters:

reference - the label to look up

Returns:

the label contained in this label set for the given reference.

getString

String getString(String section,
                 Renameable[] entities,
                 String param)

getString

String getString(String section,
                 Renameable[] entities,
                 String param,
                 String ifNull)

getString

String getString(String section,
                 String param,
                 boolean forMessageFormat)

getString

String getString(String section,
                 Renameable[] entities,
                 String param,
                 boolean forMessageFormat)

getDictionary

LanguageDictionary getDictionary()

Returns:

the dictionary associated with this label set

getPropertyFileData

PropertyFileData getPropertyFileData()

getPublicSectionNames

Set<String> getPublicSectionNames()

Returns:

the set of section names that are marked "public" in the label files

getGrammaticalTerm

GrammaticalTerm getGrammaticalTerm(String section,
                                   String param)

Test to see if the parameter contains *solely* a grammatical term, and if it does, return it, otherwise null

Parameters:

section - the section to search

param - the parameter to search.

Returns:

the grammatical term that is the only value contained for the given label, or null if the label is anything else