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

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

All Implemented Interfaces:

Container

@ExperimentalApi
public class Space
extends java.lang.Object
implements Container

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 Reference<Space>	buildReference(java.lang.String spaceKey) builds a collapsed reference to the space with the given spaceKey
java.util.Map<ContentRepresentation,FormattedBody>	getDescription()
java.util.Map<ContentRepresentation,Reference<FormattedBody>>	getDescriptionRefs()
Reference<Content>	getHomepageRef()
Reference<Icon>	getIconRef()
long	getId()
java.lang.String	getKey()
java.lang.String	getName()
static java.lang.String	getSpaceKey(Reference<Space> reference)
SpaceType	getType()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getSpaceKey

public static java.lang.String getSpaceKey(Reference<Space> reference)

buildReference

public static Reference<Space> buildReference(java.lang.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.

getId

public long getId()

getKey

public java.lang.String getKey()

getName

public java.lang.String getName()

getIconRef

public Reference<Icon> getIconRef()

getDescription

public java.util.Map<ContentRepresentation,FormattedBody> getDescription()

getDescriptionRefs

public java.util.Map<ContentRepresentation,Reference<FormattedBody>> getDescriptionRefs()

getHomepageRef

public Reference<Content> getHomepageRef()

getType

public SpaceType getType()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object