Package com.atlassian.confluence.setup.bandana

Interface KeyedBandanaContext

  • All Superinterfaces:
    com.atlassian.bandana.BandanaContext, Serializable
    All Known Implementing Classes:
    ConfluenceBandanaContext, JournalBandanaContext
    public interface KeyedBandanaContext
extends com.atlassian.bandana.BandanaContext
    BandanaContext which provides a string key. Can be used for key persistence.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getContextKey()
      A string representation of this context.

      • Methods inherited from interface com.atlassian.bandana.BandanaContext

        getParentContext, hasParentContext

    • Method Detail

      • getContextKey

        String getContextKey()
        A string representation of this context.

        This key should be unique as keys are shared across plugins and Confluence itself. Consider using a plugin key or class name.

        Note that if and only if two contexts are equal, their context keys should also be equal.

        Returns:
        a string representation of this context