org.azyva.dragom.reference

Class ReferencePath

java.lang.Object

org.azyva.dragom.reference.ReferencePath

public class ReferencePath
extends Object

Represents a reference path.

This class behaves in a way that is very similar to a List as a ReferencePath is essentially an ordered sequence of Reference's. For that reason methods in common with List are named the same.

Note that a ReferencePath is NOT a List. If it extended a List class it would carry over methods that are not appropriate for a ReferencePath.

Author:

David Raymond

Constructor Summary

Constructors

Constructor and Description
ReferencePath() Default constructor;
ReferencePath(ReferencePath referencePath) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	add(Reference reference) Adds a Reference to the end of the ReferencePath.
void	add(ReferencePath referencePath) Adds a ReferencePath to the end of this ReferencePath.
int	findModuleVersion(ModuleVersion moduleVersion) Finds a ModuleVersion.
Reference	get(int index) Returns a Reference in the ReferencePath given an index.
ModuleVersion	getLeafModuleVersion()
Reference	getLeafReference()
void	removeLeafReference() Removes the leaf Reference (from the tail of the List).
void	removeLeafReferences(int nbReferences) Removes a given number of leaf Reference (from the tail of the List).
void	removeRootReference() Removes the root Reference (from the head of the List).
void	removeRootReferences(int nbReferences) Removes a given number of root Reference's (from the head of the List).
int	size()
String	toString() ReferencePath's are often displayed to the user and need to be shown in a human-friendly and not too cryptic way.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReferencePath

public ReferencePath()

Default constructor;

ReferencePath

public ReferencePath(ReferencePath referencePath)

Copy constructor.

Parameters:

referencePath - ReferencePath.

Method Detail

add

public void add(Reference reference)

Adds a Reference to the end of the ReferencePath.

The new Reference must not create a cycle among the Module's.

Parameters:

reference - Reference.

add

public void add(ReferencePath referencePath)

Adds a ReferencePath to the end of this ReferencePath.

The new Reference must not create a cycle among the Module's.

Parameters:

referencePath - ReferencePath.

size

public int size()

Returns:

Number of Reference's in the ReferencePath.

get

public Reference get(int index)

Returns a Reference in the ReferencePath given an index.

Parameters:

index - Index.

Returns:

Reference.

removeRootReference

public void removeRootReference()

Removes the root Reference (from the head of the List).

removeRootReferences

public void removeRootReferences(int nbReferences)

Removes a given number of root Reference's (from the head of the List).

Parameters:

nbReferences - Number of references.

getLeafReference

public Reference getLeafReference()

Returns:

Leaf Reference (from the tail of the List).

getLeafModuleVersion

public ModuleVersion getLeafModuleVersion()

Returns:

Leaf ModuleVersion (from the tail of the List).

removeLeafReference

public void removeLeafReference()

Removes the leaf Reference (from the tail of the List).

removeLeafReferences

public void removeLeafReferences(int nbReferences)

Removes a given number of leaf Reference (from the tail of the List).

Parameters:

nbReferences - Number of references.

findModuleVersion

public int findModuleVersion(ModuleVersion moduleVersion)

Finds a ModuleVersion.

Parameters:

moduleVersion - ModuleVersion. The Version can be null in which case only the NodePath's of the Module's are considered.

Returns:

Index of the ModuleVersion if found. -1 if the ModuleVersion is not found.

toString

public String toString()

ReferencePath's are often displayed to the user and need to be shown in a human-friendly and not too cryptic way.

The Reference's within a ReferencePath are not totally distinct elements. A Reference includes a ModuleVersion, but also implementation data that relates to how it is expressed in some parent ModuleVersion. When such implementation data is available, the Reference is separated from its parent using "->". Otherwise, "|>" is used to denote discontinuity. This happens when Reference's are recreated during the traversal of reference graphs in some jobs.

Overrides:

toString in class Object