Package com.atlassian.confluence.spaces

Class Space

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.AnnotatedEntityObject

com.atlassian.confluence.core.ConfluenceEntityObject

com.atlassian.confluence.spaces.Space

All Implemented Interfaces:

Searchable, Addressable, ContentTypeAware, Serializable, Cloneable

Direct Known Subclasses:

ReadOnlySpace

public class Space
extends ConfluenceEntityObject
implements Searchable, Addressable, ContentTypeAware

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final int	MAX_SPACE_NAME_LENGTH
static final String	PERSONAL_SPACEKEY_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
Space()
Space(String spaceKey)

Method Summary

Modifier and Type	Method	Description
void	addPageTemplate(PageTemplate pageTemplate)
void	addPermission(SpacePermission permission)
Object	clone()
boolean	equals(Object o)
String	getAdvancedTabUrlPath()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3 use AddressableSpace.getAdvancedTabUrlPath()
String	getBlogTabUrlPath()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3 use AddressableSpace.getBlogTabUrlPath()
String	getBrowseUrlPath()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3 use AddressableSpace.getBrowseUrlPath()
URI	getDeepLinkUri()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3 use AddressableSpace.getDeepLinkUri()
Message	getDefaultHomepageTitle()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3 use SpaceManager.getDefaultHomepageTitle(boolean, String)
SpaceDescription	getDescription()
String	getDisplayTitle()
Page	getHomePage()
String	getKey()
String	getLowerKey()
String	getName()
List<PageTemplate>	getPageTemplates()
List<SpacePermission>	getPermissions()
SpaceGroup	getSpaceGroup()	Deprecated. in 5.9.
SpaceStatus	getSpaceStatus()
SpaceType	getSpaceType()
String	getType()
String	getUrlPath()
int	hashCode()
boolean	isArchived()
boolean	isGlobal()
boolean	isIndexable()	Allows an object to tell the search indexer that it is not allowed to be indexed
boolean	isPersonal()
static boolean	isValidGlobalSpaceKey(String key)
static boolean	isValidPersonalSpaceKey(String key)
static boolean	isValidSpaceKey(String key)	Is the key a valid space key of any type? Tests validity of both personal and global space keys
void	removeAllPermissions()	Remove all permissions from this Space
void	removePageTemplate(PageTemplate pageTemplate)
void	removePermission(SpacePermission permission)
void	setDescription(SpaceDescription description)
void	setHomePage(Page homePage)
void	setKey(String key)
void	setName(String name)
void	setPermissions(List<SpacePermission> permissions)
void	setSpaceGroup(SpaceGroup spaceGroup)	Deprecated. in 5.9.
void	setSpaceManager(SpaceManager spaceManager)	Deprecated. since 7.5 remove in 8.0
void	setSpaceStatus(SpaceStatus spaceStatus)
void	setSpaceType(SpaceType spaceType)
String	toString()

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.confluence.core.AnnotatedEntityObject

getCreationDate, getLastModificationDate

Methods inherited from class com.atlassian.core.bean.EntityObject

getCurrentDate, getId, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.core.Addressable

getId

Methods inherited from interface com.atlassian.bonnie.Searchable

getId, getSearchableDependants

Field Details

PERSONAL_SPACEKEY_IDENTIFIER

public static final String PERSONAL_SPACEKEY_IDENTIFIER

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

MAX_SPACE_NAME_LENGTH

public static final int MAX_SPACE_NAME_LENGTH

See Also:

• Constant Field Values

Constructor Details

Space

public Space()

Space

public Space(String spaceKey)

Method Details

isValidSpaceKey

public static boolean isValidSpaceKey(String key)

Is the key a valid space key of any type? Tests validity of both personal and global space keys

isValidGlobalSpaceKey

public static boolean isValidGlobalSpaceKey(String key)

isValidPersonalSpaceKey

public static boolean isValidPersonalSpaceKey(String key)

getName

public String getName()

setName

public void setName(String name)

getKey

public String getKey()

setKey

public void setKey(String key)

getLowerKey

public String getLowerKey()

getSpaceType

public SpaceType getSpaceType()

setSpaceType

public void setSpaceType(SpaceType spaceType)

getDescription

public SpaceDescription getDescription()

setDescription

public void setDescription(SpaceDescription description)

getHomePage

public Page getHomePage()

setHomePage

public void setHomePage(Page homePage)

getPermissions

public List<SpacePermission> getPermissions()

setPermissions

public void setPermissions(List<SpacePermission> permissions)

addPermission

public void addPermission(SpacePermission permission)

removePermission

public void removePermission(SpacePermission permission)

removeAllPermissions

public void removeAllPermissions()

Remove all permissions from this Space

Since:

5.5

getPageTemplates

public List<PageTemplate> getPageTemplates()

addPageTemplate

public void addPageTemplate(PageTemplate pageTemplate)

removePageTemplate

public void removePageTemplate(PageTemplate pageTemplate)

equals

public boolean equals(Object o)

Overrides:

equals in class com.atlassian.core.bean.EntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class com.atlassian.core.bean.EntityObject

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class com.atlassian.core.bean.EntityObject

Throws:

CloneNotSupportedException

isIndexable

public boolean isIndexable()

Description copied from interface: Searchable

Allows an object to tell the search indexer that it is not allowed to be indexed

Specified by:

isIndexable in interface Searchable

setSpaceManager

@Deprecated
public void setSpaceManager(SpaceManager spaceManager)

Deprecated.

since 7.5 remove in 8.0

getUrlPath

public String getUrlPath()

Specified by:

getUrlPath in interface Addressable

getDeepLinkUri

@Deprecated(forRemoval=true,
            since="9.3")
public URI getDeepLinkUri()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3 use AddressableSpace.getDeepLinkUri()

This method returns a link directly to the space homepage. It is not safe to persist this link as the space homepage can change. If no space homepage is defined, it falls back to getUrlPath() above.

getBrowseUrlPath

@Deprecated(forRemoval=true,
            since="9.3")
public String getBrowseUrlPath()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3 use AddressableSpace.getBrowseUrlPath()

getAdvancedTabUrlPath

@Deprecated(forRemoval=true,
            since="9.3")
public String getAdvancedTabUrlPath()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3 use AddressableSpace.getAdvancedTabUrlPath()

getBlogTabUrlPath

@Deprecated(forRemoval=true,
            since="9.3")
public String getBlogTabUrlPath()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3 use AddressableSpace.getBlogTabUrlPath()

getDisplayTitle

public String getDisplayTitle()

Specified by:

getDisplayTitle in interface Addressable

Returns:

the title of the addressable object, suitable for display in a list

getType

public String getType()

Specified by:

getType in interface ContentTypeAware

Returns:

the content type

isPersonal

public boolean isPersonal()

isGlobal

public boolean isGlobal()

getSpaceGroup

@Deprecated
public SpaceGroup getSpaceGroup()

Deprecated.

in 5.9.

SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.

setSpaceGroup

@Deprecated
public void setSpaceGroup(SpaceGroup spaceGroup)

Deprecated.

in 5.9.

SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.

getSpaceStatus

public SpaceStatus getSpaceStatus()

setSpaceStatus

public void setSpaceStatus(SpaceStatus spaceStatus)

getDefaultHomepageTitle

@Deprecated(forRemoval=true,
            since="9.3")
public Message getDefaultHomepageTitle()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3 use SpaceManager.getDefaultHomepageTitle(boolean, String)

isArchived

public boolean isArchived()

toString

public String toString()

Overrides:

toString in class Object