com.starteam
Class Link.Endpoint

java.lang.Object
  com.starteam.Link.Endpoint

Enclosing class:

Link

public static final class Link.Endpoint
extends java.lang.Object

Represents a link reference to a viewMember.

See Also:

Link, ViewMember.findLinks(), View.resolveLinkEndpoint(com.starteam.Link.Endpoint)

Method Summary

Link.Endpoint	copy() Copies this link endpoint, creating a new one with the same content.
java.lang.String	getDebugString() Returns a debug string representation of this link endpoint.
ViewMember	getDisembodiedViewMember() Resolves this link endpoint.
DotNotation	getDotNotation() Returns the dot notation for the revision being referenced by this link.
int	getFolderObjectID() Returns the object ID for the parent folder of the linked viewMember.
int	getObjectID() Returns the object ID of the underlying object referenced by the viewMember.
int	getRevisionNumber() Returns the revision number for the specific revision this link endpoint references.
ViewMember.Type	getType() Returns the Type of the viewMember for this link endpoint.
int	getViewID() Returns the view ID in which the referenced viewMember exists.
int	getVMID() Gets the ID of the view member being referenced.
boolean	isEqualTo(Link.Endpoint other) Determines whether or not the contents of two link endpoints are the same.
boolean	isPinned() Returns true if the viewMember referenced is fixed at a specific revision such that the association does not propagate to newer versions of the viewMember.
ViewMember	resolve() Gets a fully resolved version of the referenced view member.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getType

public ViewMember.Type getType()

Returns the Type of the viewMember for this link endpoint.

Returns:

the type of viewMember being referenced

See Also:

TypedResource.getType()

getVMID

public int getVMID()

Gets the ID of the view member being referenced.

Returns:

The ID of the view member being referenced.

See Also:

ViewMember.getVMID()

getObjectID

public int getObjectID()

Returns the object ID of the underlying object referenced by the viewMember. This value is only meaningful if the link is pinned. This value might be -1 if the link is not pinned. You should always use the isPinned method to determine if a link is pinned.

Returns:

the object ID for the referenced viewMember. Note that this value is only meaningful if the endpoint is pinned. The value may be -1 if the endpoint is not pinned, or may in fact be an object ID if this is the "child" endpoint of the link. In any case, always check the value of the"Pinned" property to determine whether the endpoint is pinned before relying on this value.

See Also:

Link.Endpoint.isPinned()

getRevisionNumber

public int getRevisionNumber()

Returns the revision number for the specific revision this link endpoint references. Will be -1 if the link endpoint is not "pinned"

Returns:

the revision number for the specific revision of a pinned endpoint, or -1 if the endpoint is not pinned.

See Also:

Link.Endpoint.isPinned()

getDotNotation

public DotNotation getDotNotation()

Returns the dot notation for the revision being referenced by this link. This value will be meaningless if the endpoint is not pinned.

Returns:

the dot notation for the viewMember referenced by this link if the endpoint is pinned. Not meaningful if the endpoint is not pinned.

See Also:

Link.Endpoint.isPinned()

getViewID

public int getViewID()

Returns the view ID in which the referenced viewMember exists. Note that this may not be the same as the view in which the link was obtained.

Returns:

the view ID in which the referenced viewMember exists.

See Also:

View.getViewID()

getFolderObjectID

public int getFolderObjectID()

Returns the object ID for the parent folder of the linked viewMember.

Returns:

the object ID for the parent folder of the linked viewMember.

isPinned

public boolean isPinned()

Returns true if the viewMember referenced is fixed at a specific revision such that the association does not propagate to newer versions of the viewMember.

Returns:

true if this link endpoint is pinned to a specific revision.

getDisembodiedViewMember

public ViewMember getDisembodiedViewMember()

Resolves this link endpoint.

Returns:

The link endpoint, resolved to a new "disembodied" view member.

See Also:

ViewMember, ViewMember.isDisembodied(), View.getDisembodiedViewMember(com.starteam.ViewMember.Type, int)

resolve

public ViewMember resolve()

Gets a fully resolved version of the referenced view member. This is a potentially expensive API, possibly involving the execution of several server commands

Returns:

a fully resolved version of the referenced view member.

isEqualTo

public boolean isEqualTo(Link.Endpoint other)

Determines whether or not the contents of two link endpoints are the same.

Parameters:

other - The link endpoint to be compared to this one.

Returns:

true if the link endpoints are the same; false otherwise.

copy

public Link.Endpoint copy()

Copies this link endpoint, creating a new one with the same content.

Returns:

A new copy of this link endpoint.

getDebugString

public java.lang.String getDebugString()

Returns a debug string representation of this link endpoint.

Returns:

a debug string representation of this link endpoint.