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

Class ModelObjectReferenceBase<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>>

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<T,R>

com.polarion.alm.shared.api.model.ModelObjectReferenceBase<T,R>

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, ModelEntityReference, ModelObjectReference, Serializable

Direct Known Subclasses:

BaselineReference, ModelObjectReferenceWithUpdatable

public abstract class ModelObjectReferenceBase<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>>
extends ModelEntityReferenceBase<T,R>
implements ModelObjectReference

Generic implementation of ModelObjectReference interface. Should be used only in rare cases of generic code where unchecked cast would be otherwise needed.

Since:

3.9.0

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
final String	actualRevision()	Returns the revision from which the object was actually read even when the ModelObjectReference.requestedRevision() was null.
boolean	equals(Object obj)
T	get(ReadOnlyTransaction transaction)	Returns the entity referenced by this reference.
R	getCurrent()	Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.
final T	getCurrent(ReadOnlyTransaction transaction)	Returns the current object ignoring both ModelObjectReference.requestedRevision() and ModelObjectReference.actualRevision().
abstract T	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)
final T	getOriginal(ReadOnlyTransaction transaction)	Returns the object from ModelObjectReference.requestedRevision() or ModelObjectReference.actualRevision() if either of them is not null (checked in this order), otherwise returns the current object same as by calling ModelObjectReference.getCurrent(ReadOnlyTransaction).
abstract R	getWithRevision(String requestedRevision)	Returns the reference to the same object, but with different ModelObjectReference.requestedRevision(), the ModelObjectReference.actualRevision() of the returned reference is null.
int	hashCode()
String	projectId()	It is shortcut for ModelObjectReference.scope().Scope.projectId()
final String	requestedRevision()
final String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.polarion.alm.shared.api.model.ModelObjectReference

prototype, scope, toPath

Method Details

getFromRevision

@NotNull
public abstract T getFromRevision(@NotNull
 ReadOnlyTransaction transaction,
 @Nullable
 String requestedRevision)

Specified by:

getFromRevision in interface ModelObjectReference

requestedRevision - - null means current revision

get

@NotNull
public T 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 interface ModelObjectReference

Specified by:

get in class ModelEntityReferenceBase<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>>

See Also:

• ModelObjectReference.get(ReadOnlyTransaction)

getOriginal

@NotNull
public final T getOriginal(@NotNull
 ReadOnlyTransaction transaction)

Description copied from interface: ModelObjectReference

Returns the object from ModelObjectReference.requestedRevision() or ModelObjectReference.actualRevision() if either of them is not null (checked in this order), otherwise returns the current object same as by calling ModelObjectReference.getCurrent(ReadOnlyTransaction).

Specified by:

getOriginal in interface ModelObjectReference

getCurrent

@NotNull
public final T getCurrent(@NotNull
 ReadOnlyTransaction transaction)

Description copied from interface: ModelObjectReference

Returns the current object ignoring both ModelObjectReference.requestedRevision() and ModelObjectReference.actualRevision().

Specified by:

getCurrent in interface ModelObjectReference

actualRevision

@Nullable
public final String actualRevision()

Description copied from interface: ModelObjectReference

Returns the revision from which the object was actually read even when the ModelObjectReference.requestedRevision() was null. This value does not have impact in Object.hashCode() and Object.equals(Object) methods.
Never returns empty string or string containing only white space characters.

Specified by:

actualRevision in interface ModelObjectReference

requestedRevision

@Nullable
public final String requestedRevision()

Specified by:

requestedRevision in interface ModelObjectReference

Returns:

revision which was requested by user. Never returns empty string or string containing only white space characters.

getWithRevision

@NotNull
public abstract R getWithRevision(@Nullable
 String requestedRevision)

Description copied from interface: ModelObjectReference

Returns the reference to the same object, but with different ModelObjectReference.requestedRevision(), the ModelObjectReference.actualRevision() of the returned reference is null.

Specified by:

getWithRevision in interface ModelObjectReference

See Also:

• which is shortcut for calling this method with null

getCurrent

@NotNull
public R getCurrent()

Description copied from interface: ModelObjectReference

Returns the reference to current revision of the object, in other words reference without requested revision and actual revision. It is shortcut for calling ModelObjectReference.getWithRevision(String) with null

Specified by:

getCurrent in interface ModelObjectReference

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class ModelEntityReferenceBase<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>>

projectId

@Nullable
public String projectId()

Description copied from interface: ModelObjectReference

It is shortcut for ModelObjectReference.scope().Scope.projectId()

Specified by:

projectId in interface ModelObjectReference