Package com.atlassian.bandana

Interface BandanaManager

All Known Subinterfaces:
BandanaManagerInternal
All Known Implementing Classes:
DefaultBandanaManager
@Deprecated public interface BandanaManager
Deprecated.
since 9.3, for removal in 11.0. Consider a combination of the linked alternatives.
A plugin manager is responsible for retrieving plugins and modules, as well as managing plugin loading and state.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterable<String>
    getKeys(BandanaContext context)
    Deprecated.
    Gets all the keys for entries under the given context.
    default Object
    getValue(BandanaContext context, String key)
    Deprecated.
    since 9.4, use PluginSettings.get(java.lang.String) instead.
    Object
    getValue(BandanaContext context, String key, boolean lookUp)
    Deprecated.
    since 9.4, use PluginSettings.get(java.lang.String) instead.
    default void
    init()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 9.4, no replacement.
    void
    removeValue(BandanaContext context, String key)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 9.4, use PluginSettings.remove(java.lang.String) instead.
    void
    setValue(BandanaContext context, String key, Object value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 9.4, use PluginSettings.put(java.lang.String, java.lang.Object) instead.

  • Method Details

    • init

      @Deprecated(forRemoval=true) default void init()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.4, no replacement.
      Initialise the bandana manager. This must be called before anything else.

    • setValue

      @Deprecated(forRemoval=true) void setValue(BandanaContext context, String key, Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.4, use PluginSettings.put(java.lang.String, java.lang.Object) instead.
      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

      @Deprecated default Object getValue(BandanaContext context, String key)
      Deprecated.
      since 9.4, use PluginSettings.get(java.lang.String) instead.
      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

      @Deprecated Object getValue(BandanaContext context, String key, boolean lookUp)
      Deprecated.
      since 9.4, use PluginSettings.get(java.lang.String) instead.
      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)
      Deprecated.
      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

      @Deprecated(forRemoval=true) void removeValue(BandanaContext context, String key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.4, use PluginSettings.remove(java.lang.String) instead.
      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