com.force.i18n

Class LabelRef

java.lang.Object

com.force.i18n.LabelRef

All Implemented Interfaces:

LabelReference, Serializable, Comparable<LabelRef>

public class LabelRef
extends Object
implements Comparable<LabelRef>, LabelReference, Serializable

Reference to a specific label in labels.xml (section and key). Also allows storage of optional arguments. This is nice if you want to store static references. For smaller projects, you could auto-generate these from the label files kind of like what eclipse does. For larger projects you end up killing PermGen Called LabelRef to save on typing

Author:

nhorne

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LabelRef(String section, String key) Construct a Labelref for the given section and key
LabelRef(String section, String key, Object... args) Construct a Labelref for the given section, key, and optional arguments

Method Summary

Modifier and Type	Method and Description
int	compareTo(LabelRef o)
boolean	equals(Object obj)
Object[]	getArguments()
static LabelRef	getInstance(String dotted)
String	getKey()
String	getSection()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LabelRef

public LabelRef(String section,
                String key,
                Object... args)

Construct a Labelref for the given section, key, and optional arguments

Parameters:

section - the section for the label

key - the key for the label

args - optional arguments that should be used in message format replacement

LabelRef

public LabelRef(String section,
                String key)

Construct a Labelref for the given section and key

Parameters:

section - the section for the label

key - the key for the label

Method Detail

getSection

public String getSection()

Specified by:

getSection in interface LabelReference

Returns:

the section in which the label is defined

getKey

public String getKey()

Specified by:

getKey in interface LabelReference

Returns:

the key for the label

getArguments

public Object[] getArguments()

Specified by:

getArguments in interface LabelReference

Returns:

the arguments for this label, or null if there are none

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(LabelRef o)

Specified by:

compareTo in interface Comparable<LabelRef>

toString

public String toString()

Overrides:

toString in class Object

getInstance

public static LabelRef getInstance(String dotted)