com.starteam
Class TraceFinder.Direction

java.lang.Object
  com.starteam.TraceFinder.Direction

Enclosing class:

TraceFinder

public static final class TraceFinder.Direction
extends java.lang.Object

Allows a set of traces to be filtered by direction.

See Also:

TraceCollection.getTraces(ViewMember,TraceFinder.Direction,TraceFinder.PinType), TraceCollection.getTraces(LinkValue,TraceFinder.Direction,TraceFinder.PinType), TraceCollection.getTraces(String,TraceFinder.Direction,TraceFinder.PinType)

Field Summary

static TraceFinder.Direction[]	ALL Get an array containing all available Directions.
static TraceFinder.Direction	ANY Does not filter by direction.
static TraceFinder.Direction	FROM The requested item must be the source of the trace.
static TraceFinder.Direction	TO The requested item must be the target of the trace.

Method Summary

boolean	equals(java.lang.Object o) compares two origins for equality
static TraceFinder.Direction	fromID(int id) Gets the Direction for a given ID.
int	getID() Gets the unique integer ID of this Direction.
int	hashCode() returns the hash code for this direction

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANY

public static final TraceFinder.Direction ANY

Does not filter by direction. The requested item may be either the source or target of the trace.

FROM

public static final TraceFinder.Direction FROM

The requested item must be the source of the trace.

TO

public static final TraceFinder.Direction TO

The requested item must be the target of the trace.

ALL

public static final TraceFinder.Direction[] ALL

Get an array containing all available Directions.

Method Detail

getID

public int getID()

Gets the unique integer ID of this Direction.

Returns:

The ID of this Direction.

fromID

public static TraceFinder.Direction fromID(int id)

Gets the Direction for a given ID.

Parameters:

id - An integer ID.

Returns:

The Direction with the given ID.

Throws:

java.lang.IllegalArgumentException - if there is no Direction with the given ID.

equals

public boolean equals(java.lang.Object o)

compares two origins for equality

Overrides:

equals in class java.lang.Object

Parameters:

o - the origin to compare

Returns:

true if the two origins are considered equal

hashCode

public int hashCode()

returns the hash code for this direction

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this direction