Space (Atlassian Confluence 1001.0.0-SNAPSHOT API)

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

All Implemented Interfaces:: Container, Relatable, NavigationAware

@ExperimentalApi
 @FieldsAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public class Space
extends Object
implements Container, NavigationAware, Relatable

Representation of a Confluence Space.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Space.Expansions` Provides property names that can be used to expand `Space` objects.
`static class`	`Space.MetadataKeys` Provides property names that can be used to expand metadata
`static class`	`Space.SpaceBuilder` Builds `Space` objects.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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
`boolean`	`equals(Object obj)`
`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()`
`Map<LinkType,Link>`	`getLinks()`
`LookAndFeel`	`getLookAndFeel()`
`Reference<LookAndFeel>`	`getLookAndFeelRef()`
`Map<String,Object>`	`getMetadata()`
`static List<MetadataProperty>`	`getMetadataProperties()`
`String`	`getName()`
`List<OperationCheckResult>`	`getOperations()`
`List<SpacePermission>`	`getPermissions()`
`SpaceSettings`	`getSettings()`
`Reference<SpaceSettings>`	`getSettingsRef()`
`static String`	`getSpaceKey(Reference<Space> reference)`
`SpaceStatus`	`getStatus()`
`Theme`	`getTheme()`
`Reference<Theme>`	`getThemeRef()`
`SpaceType`	`getType()`
`int`	`hashCode()`
`boolean`	`hasMetadata()`
`Navigation.Builder`	`resolveNavigation(NavigationService navigationService)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, 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
```
@Nullable
public String getKey()
```

getName
```
@Nullable
public String getName()
```

getIconRef
```
public Reference<Icon> getIconRef()
```

getDescription

public Map<ContentRepresentation,FormattedBody> getDescription()

getMetadata

public Map<String,Object> getMetadata()

hasMetadata
```
public boolean hasMetadata()
```

getOperations

public List<OperationCheckResult> getOperations()

getPermissions

public List<SpacePermission> getPermissions()

getDescriptionRefs

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

Deprecated. Since 5.5.1 Use getDescription().

getHomepageRef

public Reference<Content> getHomepageRef()

getLinks
```
public Map<LinkType,Link> getLinks()
```

getType
```
public SpaceType getType()
```

getStatus
```
public SpaceStatus getStatus()
```

getSettingsRef

public Reference<SpaceSettings> getSettingsRef()

getSettings
```
public SpaceSettings getSettings()
```

getThemeRef
```
public Reference<Theme> getThemeRef()
```

getTheme
```
public Theme getTheme()
```

getLookAndFeelRef

public Reference<LookAndFeel> getLookAndFeelRef()

getLookAndFeel
```
public LookAndFeel getLookAndFeel()
```

resolveNavigation

public Navigation.Builder resolveNavigation(NavigationService navigationService)

Specified by:: resolveNavigation in interface NavigationAware

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getMetadataProperties

public static List<MetadataProperty> getMetadataProperties()

Class Space

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSpaceKey

buildReference

builder

builder

getId

getKey

getName

getIconRef

getDescription

getMetadata

hasMetadata

getOperations

getPermissions

getDescriptionRefs

getHomepageRef

getLinks

getType

getStatus

getSettingsRef

getSettings

getThemeRef

getTheme

getLookAndFeelRef

getLookAndFeel

resolveNavigation

toString

equals

hashCode

getMetadataProperties