com.atlassian.bandana

Interface BandanaManager

All Known Implementing Classes:

DefaultBandanaManager

public interface BandanaManager

A plugin manager is responsible for retrieving plugins and modules, as well as managing plugin loading and state. Copied from atlassian-bandana 3.1

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getContextEntries(BandanaContext context) Gets all the entries under the given context.
Iterable<String>	getKeys(BandanaContext context) Gets all the keys for entries under the given context.
Object	getValue(BandanaContext context, String key) Get the configuration object, starting with the given context and looking upwards.
Object	getValue(BandanaContext context, String key, boolean lookUp) Get the configuration object, starting with the given context
void	init() Initialise the bandana manager.
void	removeValue(BandanaContext context, String key) Remove the configuration object, using the given context.
void	setValue(BandanaContext context, String key, Object value) Set a configuration object with the given context.

Method Detail

init

void init()

Initialise the bandana manager. This must be called before anything else.

setValue

void setValue(BandanaContext context,
              String key,
              Object value)

Set a configuration object with the given context.

Parameters:

context - The context to store this value in

key - The key of the object

value - The value to be stored

getValue

Object getValue(BandanaContext context,
                String key)

Get the configuration object, starting with the given context and looking upwards.

Parameters:

context - The context to start looking in

key - The key of the BandanaConfigurationObject object

Returns:

Object object for this key, or null if none exists.

getValue

Object getValue(BandanaContext context,
                String key,
                boolean lookUp)

Get the configuration object, starting with the given context

Parameters:

context - The context to start looking in

key - The key of the BandanaConfigurationObject object

lookUp - Whether or not to look up the context hierarchy if no context is found

Returns:

Object object for this key, or null if none exists.

getKeys

Iterable<String> getKeys(BandanaContext context)

Gets all the keys for entries under the given context. Will not look upwards to other contexts.

Parameters:

context - the context for which to find keys

Returns:

all keys for supplied context

removeValue

void removeValue(BandanaContext context,
                 String key)

Remove the configuration object, using the given context. Will modify other contexts.

Parameters:

context - the context to look in

key - the key of the configuration object

getContextEntries

Map<String,Object> getContextEntries(BandanaContext context)

Gets all the entries under the given context. Will not look upwards to other contexts.

Parameters:

context - the context to look in

Returns:

an immutable mapping between all the keys in the context and their corresponding values.