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

Class RevisionReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<Revision,RevisionReference>

com.polarion.alm.shared.api.model.revision.RevisionReference

All Implemented Interfaces:

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

public final class RevisionReference
extends ModelEntityReferenceBase<Revision,RevisionReference>
implements HasPortalLink, HasId

Since:

3.9.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_REPOSITORY_NAME

Constructor Summary

Constructors

Constructor	Description
RevisionReference(String repositoryName, String id)

Method Summary

Modifier and Type	Method	Description
PortalLink	createLink(SharedContext context)	Creates portal link.
boolean	equals(Object obj)
static RevisionReference	fromPath(String path)
Revision	get(ReadOnlyTransaction transaction)	Returns the entity referenced by this reference.
int	hashCode()
String	id()
boolean	isDefaultRepository()
String	repositoryName()
String	toPath()	Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId'. It ignores requested revision.

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_REPOSITORY_NAME

public static String DEFAULT_REPOSITORY_NAME

Constructor Details

RevisionReference

public RevisionReference(@Nullable
 String repositoryName,
 @NotNull
 String id)

Parameters:

repositoryName - - null or empty string means DEFAULT_REPOSITORY_NAME

Throws:

IllegalArgumentException - when id is empty string

Method Details

get

@NotNull
public Revision 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<Revision,RevisionReference>

See Also:

• ModelObjectReference.get(ReadOnlyTransaction)

id

@NotNull
public String id()

Specified by:

id in interface HasId

repositoryName

@NotNull
public String repositoryName()

See Also:

• isDefaultRepository()
• DEFAULT_REPOSITORY_NAME

isDefaultRepository

public boolean isDefaultRepository()

Returns:

true when repositoryName() is equal to DEFAULT_REPOSITORY_NAME

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toPath

@NotNull
public String toPath()

Description copied from interface: ModelEntityReference

Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId'.
It ignores requested revision.

Specified by:

toPath in interface ModelEntityReference

See Also:

• ModelObjectSelector.path(String)

createLink

@NotNull
public PortalLink createLink(@NotNull
 SharedContext context)

Description copied from interface: HasPortalLink

Creates portal link.

Specified by:

createLink in interface HasPortalLink

Throws:

IllegalStateException - when the revision is not from default repository

See Also:

• isDefaultRepository()
• DEFAULT_REPOSITORY_NAME

fromPath

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