Package com.atlassian.confluence.setup.bandana

Class ConfluenceBandanaContext

java.lang.Object

com.atlassian.confluence.setup.bandana.ConfluenceBandanaContext

All Implemented Interfaces:

BandanaContext, KeyedBandanaContext, Serializable

public class ConfluenceBandanaContext
extends Object
implements KeyedBandanaContext

Simple KeyedBandanaContext which falls back to the global context if the key is not found.

Since:

1.3

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfluenceBandanaContext	GLOBAL_CONTEXT
static final String	GLOBAL_CONTEXT_KEY

Constructor Summary

Constructors

Constructor	Description
ConfluenceBandanaContext()
ConfluenceBandanaContext(Space space)
ConfluenceBandanaContext(String key)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getContextKey()	A string representation of this context.
BandanaContext	getParentContext()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bandana.BandanaContext

hasParentContext

Field Details

GLOBAL_CONTEXT_KEY

public static final String GLOBAL_CONTEXT_KEY

See Also:

• Constant Field Values

GLOBAL_CONTEXT

public static final ConfluenceBandanaContext GLOBAL_CONTEXT

Constructor Details

ConfluenceBandanaContext

public ConfluenceBandanaContext()

ConfluenceBandanaContext

public ConfluenceBandanaContext(Space space)

ConfluenceBandanaContext

public ConfluenceBandanaContext(String key)

Method Details

getContextKey

public String getContextKey()

Description copied from interface: KeyedBandanaContext

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.

Specified by:

getContextKey in interface KeyedBandanaContext

Returns:

a string representation of this context

getParentContext

public BandanaContext getParentContext()

Specified by:

getParentContext in interface BandanaContext

Returns:

This context's parent, or null if it is a root context.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object