Container

public class Container extends Object

An object that provides access to container values. Container objects must be created via one of the TagManager loadContainer calls. Once a container is created, it can be queried for key values which may depend on rules established for the container.

Nested Class Summary

interface Container.FunctionCallMacroCallback Callback that is provided by the application to calculate the value of a custom macro. 
interface Container.FunctionCallTagCallback Callback that is provided by the application to execute a custom tag. 

Public Method Summary

boolean
getBoolean(String key)
Returns a boolean representing the configuration value for the given key.
String
getContainerId()
Returns the container id.
double
getDouble(String key)
Returns a double representing the configuration value for the given key.
long
getLastRefreshTime()
Returns the last time (in milliseconds since midnight, January 1, 1970 UTC) that this container was refreshed from the network.
long
getLong(String key)
Returns a long representing the configuration value for the given key.
String
getString(String key)
Returns a string representing the configuration value for the given key.
boolean
isDefault()
Returns whether this is a default container, or one refreshed from the server.
void
registerFunctionCallMacroCallback(String customMacroName, Container.FunctionCallMacroCallback customMacroCallback)
Registers the given macro callback to handle a given function call macro.
void
registerFunctionCallTagCallback(String customTagName, Container.FunctionCallTagCallback customTagCallback)
Registers the tag callback to handle a given function call tag.
void
unregisterFunctionCallMacroCallback(String customMacroName)
Unregisters any macro callback for the given macro.
void
unregisterFunctionCallTagCallback(String customTagName)
Unregisters any tag callback for the given tag.

Inherited Method Summary

Public Methods

public boolean getBoolean (String key)

Returns a boolean representing the configuration value for the given key. If the container has no value for this key, false will be returned.

public String getContainerId ()

Returns the container id.

public double getDouble (String key)

Returns a double representing the configuration value for the given key. If the container has no value for this key, 0 will be returned.

public long getLastRefreshTime ()

Returns the last time (in milliseconds since midnight, January 1, 1970 UTC) that this container was refreshed from the network.

public long getLong (String key)

Returns a long representing the configuration value for the given key. If the container has no value for this key, 0 will be returned.

public String getString (String key)

Returns a string representing the configuration value for the given key. If the container has no value for this key, an empty string will be returned.

public boolean isDefault ()

Returns whether this is a default container, or one refreshed from the server.

public void registerFunctionCallMacroCallback (String customMacroName, Container.FunctionCallMacroCallback customMacroCallback)

Registers the given macro callback to handle a given function call macro.

Parameters
customMacroName the name of the macro which is being registered
customMacroCallback the callback to register

public void registerFunctionCallTagCallback (String customTagName, Container.FunctionCallTagCallback customTagCallback)

Registers the tag callback to handle a given function call tag.

Parameters
customTagName the name of the tag which is being registered
customTagCallback the callback to register

public void unregisterFunctionCallMacroCallback (String customMacroName)

Unregisters any macro callback for the given macro.

Parameters
customMacroName the name of the macro which is being unregistered

public void unregisterFunctionCallTagCallback (String customTagName)

Unregisters any tag callback for the given tag.

Parameters
customTagName the name of the tag which is being unregistered