org.jgrapht.util

Class VertexPair<V>

java.lang.Object

org.jgrapht.util.VertexPair<V>

Type Parameters:

V - the graph vertex type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UnorderedVertexPair

public class VertexPair<V>
extends Object
implements Serializable

Representation of a pair of vertices; to be replaced by Pair<V,V> if Sun ever gets around to adding Pair to java.util.

Author:

Soren (soren@tanesha.net), Joris Kinable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected V	n1
protected V	n2

Constructor Summary

Constructors

Constructor and Description
VertexPair(V n1, V n2) Create a new vertex pair

Method Summary

Modifier and Type	Method and Description
protected boolean	elementEquals(V element1, V element2) Compares two elements.
boolean	equals(Object o)
V	getFirst() Get the first vertex of the pair
V	getOther(V one) Given on of the vertices of the pair, get the other.
V	getSecond() Get the second vertex of the pair
int	hashCode()
boolean	hasVertex(V v) Assess if this pair contains the vertex.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

n1

protected final V n1

n2

protected final V n2

Constructor Detail

VertexPair

public VertexPair(V n1,
                  V n2)

Create a new vertex pair

Parameters:

n1 - the first vertex

n2 - the second vertex

Method Detail

getFirst

public V getFirst()

Get the first vertex of the pair

Returns:

the first vertex of the pair

getSecond

public V getSecond()

Get the second vertex of the pair

Returns:

the second vertex of the pair

hasVertex

public boolean hasVertex(V v)

Assess if this pair contains the vertex.

Parameters:

v - The vertex in question

Returns:

true if contains, false otherwise

getOther

public V getOther(V one)

Given on of the vertices of the pair, get the other.

Parameters:

one - one of the vertices

Returns:

the other vertex of the pair

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

elementEquals

protected boolean elementEquals(V element1,
                                V element2)

Compares two elements. Returns true if they are both null, or when they are equal.

Parameters:

element1 - the first element

element2 - the second element

Returns:

true if they are both null, or when they are equal, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object