Package com.polarion.alm.shared.api.model.space

Class SpaceReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<Space,SpaceReference>

com.polarion.alm.shared.api.model.space.SpaceReference

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, HasProjectId, ModelEntityReference, HasPortalLink, Serializable

public final class SpaceReference
extends ModelEntityReferenceBase<Space,SpaceReference>
implements HasPortalLink, HasProjectId

Since:

3.9.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SPACE

Constructor Summary

Constructors

Constructor	Description
SpaceReference(String projectId, String spaceId)

Method Summary

Modifier and Type	Method	Description
SpaceLinkBuilder	createLink(SharedContext context)	Creates portal link.
boolean	equals(Object obj)
static SpaceReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. See toPath()
Space	get(ReadOnlyTransaction transaction)	Returns the entity referenced by this reference.
int	hashCode()
boolean	isDefault()
String	projectId()
Scope	scope()
String	spaceId()	Returns space id.
String	spacePath()	Deprecated. Use spaceId() instead.
String	toPath()	Returns path to the space including the project id when the space is from project.

Methods inherited from class com.polarion.alm.shared.api.model.ModelEntityReferenceBase

toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_SPACE

public static final String DEFAULT_SPACE

See Also:

• Constant Field Values

Constructor Details

SpaceReference

public SpaceReference(@Nullable
 String projectId,
 @Nullable
 String spaceId)

Parameters:

spaceId - - when null then DEFAULT_SPACE is assumed, '/' characters at the start and end are removed

Throws:

IllegalArgumentException - when spaceId contains two following slashes "//", except start or end where they are removed

Method Details

fromPath

@NotNull
public static SpaceReference fromPath(@NotNull
 String path)

The path is trimmed before parsing, so it can contain spaces at the start or end.

See toPath()

get

@NotNull
public Space get(@NotNull
 ReadOnlyTransaction transaction)

Description copied from class: ModelEntityReferenceBase

Returns the entity referenced by this reference.

Specified by:

get in interface ModelEntityReference

Specified by:

get in class ModelEntityReferenceBase<Space,SpaceReference>

See Also:

• ModelObjectReference.get(ReadOnlyTransaction)

projectId

@Nullable
public String projectId()

Specified by:

projectId in interface HasProjectId

spacePath

@NotNull
@Deprecated
public String spacePath()

Deprecated.

Use spaceId() instead.

Since all nested Spaces are not actually nested in the repository (they are all on the same level there), the spacePath will just be the Space id. For the full Space hierarchy path label See Space.label() method.

spaceId

@NotNull
public String spaceId()

Returns space id. For the full Space hierarchy path label See Space.label() method.

Since:

3.19.0

isDefault

public boolean isDefault()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

scope

@NotNull
public Scope scope()

toPath

@NotNull
public String toPath()

Returns path to the space including the project id when the space is from project.

Specified by:

toPath in interface ModelEntityReference

See Also:

• fromPath(String)

createLink

@NotNull
public SpaceLinkBuilder createLink(@NotNull
 SharedContext context)

Description copied from interface: HasPortalLink

Creates portal link.

Specified by:

createLink in interface HasPortalLink