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.

Method Summary

String	exportValues(BandanaContext context) Get all the values stored in bandana for this 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	importValues(BandanaContext context, String xmlValues) Replace all the values stored in bandana for this context with values read from the XML string supplied, which is guaranteed to have been produced by exportValues().
void	init() Initialise the bandana manager.
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.

exportValues

String exportValues(BandanaContext context)

Get all the values stored in bandana for this context. Note that this doesn't look up parent contexts. The values are exported as an XML string understood by importValues().

importValues

void importValues(BandanaContext context,
                  String xmlValues)

Replace all the values stored in bandana for this context with values read from the XML string supplied, which is guaranteed to have been produced by exportValues().