com.atlassian.confluence.api.model.content
Class Space

java.lang.Object
  com.atlassian.confluence.api.model.content.Space

All Implemented Interfaces:

Container, NavigationAware

@ExperimentalApi
public class Space
extends Object
implements Container, NavigationAware

Representation of a Confluence Space.

Nested Class Summary

static class	Space.Expansions Provides property names that can be used to expand Space objects.
static class	Space.SpaceBuilder Builds Space objects.

Method Summary

static Space.SpaceBuilder	builder() Returns a Space.SpaceBuilder instance that can be used to create a new Space object.
static Space.SpaceBuilder	builder(Space space)
static Reference<Space>	buildReference(String spaceKey) builds a collapsed reference to the space with the given spaceKey
Map<ContentRepresentation,FormattedBody>	getDescription()
Map<ContentRepresentation,Reference<FormattedBody>>	getDescriptionRefs() Deprecated. Since 5.5.1 Use getDescription().
Reference<Content>	getHomepageRef()
Reference<Icon>	getIconRef()
long	getId()
String	getKey()
String	getName()
static String	getSpaceKey(Reference<Space> reference)
SpaceType	getType()
Navigation.Builder	resolveNavigation(NavigationService navigationService)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getSpaceKey

public static String getSpaceKey(Reference<Space> reference)

buildReference

public static Reference<Space> buildReference(String spaceKey)

builds a collapsed reference to the space with the given spaceKey

Parameters:

spaceKey - - the space key of the space

Returns:

a reference to a space

builder

public static Space.SpaceBuilder builder()

Returns a Space.SpaceBuilder instance that can be used to create a new Space object.

builder

public static Space.SpaceBuilder builder(Space space)

getId

public long getId()

getKey

public String getKey()

getName

public String getName()

getIconRef

public Reference<Icon> getIconRef()

getDescription

public Map<ContentRepresentation,FormattedBody> getDescription()

getDescriptionRefs

@Deprecated
public Map<ContentRepresentation,Reference<FormattedBody>> getDescriptionRefs()

Deprecated. Since 5.5.1 Use getDescription().

getHomepageRef

public Reference<Content> getHomepageRef()

getType

public SpaceType getType()

resolveNavigation

public Navigation.Builder resolveNavigation(NavigationService navigationService)

Specified by:

resolveNavigation in interface NavigationAware

toString

public String toString()

Overrides:

toString in class Object