com.force.i18n

Class LabelDebugProvider

java.lang.Object

com.force.i18n.LabelDebugProvider

public abstract class LabelDebugProvider
extends Object

Provide access to LabelDebugging. This class has two distinct implementations, one which does nothing and one which may add some helpful hints to the end of every label on a page and keep a list of those labels around for display.

Author:

stamm (from rchen/150)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LabelDebugProvider.LabelDebugContinuation Marker interface for a debug continuation so that label hints can survive reestablishing requests

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MASK
protected static String	TRACE

Constructor Summary

Constructors

Constructor and Description
LabelDebugProvider()

Method Summary

Modifier and Type	Method and Description
static String	formatStackTrace(StackTraceElement[] stack, int startFrame, int maxFrames)
static LabelDebugProvider	get()
LabelDebugProvider.LabelDebugContinuation	getContinuation()
List<LabelDebug>	getLabelDebugs()
abstract com.google.common.collect.SetMultimap<String,String>	getUsedLabels()
abstract boolean	isAllowed()
boolean	isLabelHintRequest() Determines if the current Request should show the Label Debugging images.
abstract boolean	isTrackingLabelUsage()
abstract String	makeLabelHintIfRequested(String text, String section, String key) Given a label reference, and it's text, possibly modify the hint to provide help
void	setContinuation(LabelDebugProvider.LabelDebugContinuation continuation)
static void	setLabelDebugProviderEnabled(boolean enabled) Set the debug provider to be enabled or disabled
static void	setLabelDebugProviderEnabled(LabelDebugProvider provider) Set the debug provider to be used.
abstract void	setLabelHintMode(String value) Set the label hint mode.
abstract boolean	setLabelHintRequest(boolean value) Sets the value of the current request as to whether it
abstract void	setTrackingLabelUsage(boolean trackUsage) Set whether we are tracking label usage or not
abstract void	trackLabel(String section, String key) Mark the label as being tracked:

Methods inherited from class java.lang.Object

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

Field Detail

TRACE

protected static final String TRACE

See Also:

Constant Field Values

MASK

protected static final String MASK

See Also:

Constant Field Values

Constructor Detail

LabelDebugProvider

public LabelDebugProvider()

Method Detail

get

public static LabelDebugProvider get()

setLabelDebugProviderEnabled

public static void setLabelDebugProviderEnabled(boolean enabled)

Set the debug provider to be enabled or disabled

setLabelDebugProviderEnabled

public static void setLabelDebugProviderEnabled(LabelDebugProvider provider)

Set the debug provider to be used. Generally you want to use the boolean value and rely on the default behavior

makeLabelHintIfRequested

public abstract String makeLabelHintIfRequested(String text,
                                                String section,
                                                String key)

Given a label reference, and it's text, possibly modify the hint to provide help

Parameters:

text - the text value of the label

section - the section for the label

key - the key for the label

Returns:

the text passed in, possibly with some hinting information appended.

isAllowed

public abstract boolean isAllowed()

Returns:

whether or not label debugging is ever allowed

isLabelHintRequest

public boolean isLabelHintRequest()

Determines if the current Request should show the Label Debugging images.

getContinuation

public LabelDebugProvider.LabelDebugContinuation getContinuation()

Returns:

a continuation of the current label debug list so that it can survive re-establishing the localization context

setContinuation

public void setContinuation(LabelDebugProvider.LabelDebugContinuation continuation)

Parameters:

continuation - the continuation returned from getContinuation to use to establish the request afterwards

isTrackingLabelUsage

public abstract boolean isTrackingLabelUsage()

Returns:

whether we are tracking label usage or not

setTrackingLabelUsage

public abstract void setTrackingLabelUsage(boolean trackUsage)

Set whether we are tracking label usage or not

Parameters:

trackUsage - whether usage should be tracked Note: This is not threadsafe, and you should synchronize on the object before setting.

trackLabel

public abstract void trackLabel(String section,
                                String key)

Mark the label as being tracked:

Parameters:

section - the section of the label

key - the key of the label

getUsedLabels

public abstract com.google.common.collect.SetMultimap<String,String> getUsedLabels()

Returns:

the set of labels used so far in the application, returned as an unmodifiable multimap from section to key

setLabelHintRequest

public abstract boolean setLabelHintRequest(boolean value)

Sets the value of the current request as to whether it

Parameters:

value - the value of the

Returns:

the previous value of the request.

setLabelHintMode

public abstract void setLabelHintMode(String value)

Set the label hint mode.

Parameters:

value - either null, TRACE or MASK

getLabelDebugs

public List<LabelDebug> getLabelDebugs()

formatStackTrace

public static String formatStackTrace(StackTraceElement[] stack,
                                      int startFrame,
                                      int maxFrames)