Package com.atlassian.confluence.setup.bandana

Class ConfluenceBandanaContext

java.lang.Object

com.atlassian.confluence.setup.bandana.ConfluenceBandanaContext

All Implemented Interfaces:

com.atlassian.bandana.BandanaContext, KeyedBandanaContext, Serializable

public class ConfluenceBandanaContext
extends Object
implements KeyedBandanaContext

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ConfluenceBandanaContext	GLOBAL_CONTEXT

Constructor Summary

Constructors

Constructor	Description
ConfluenceBandanaContext()	Create a global context
ConfluenceBandanaContext(Space space)	Create a space context
ConfluenceBandanaContext(String spaceKey)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_CONTEXT

public static final ConfluenceBandanaContext GLOBAL_CONTEXT

Constructor Detail

ConfluenceBandanaContext

public ConfluenceBandanaContext()

Create a global context

ConfluenceBandanaContext

public ConfluenceBandanaContext(Space space)

Create a space context

Parameters:

space -

ConfluenceBandanaContext

public ConfluenceBandanaContext(String spaceKey)

Method Detail

getSpaceKey

public String getSpaceKey()

getParentContext

public com.atlassian.bandana.BandanaContext getParentContext()

Specified by:

getParentContext in interface com.atlassian.bandana.BandanaContext

hasParentContext

public boolean hasParentContext()

Specified by:

hasParentContext in interface com.atlassian.bandana.BandanaContext

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

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 that identifies the particular context in Confluence. Different instances that refer to the same space will have the same key.

isGlobal

public boolean isGlobal()