sequenceextractor

Class LevelOrderPair

java.lang.Object

sequenceextractor.LevelOrderPair

All Implemented Interfaces:

Comparable<LevelOrderPair>

public class LevelOrderPair
extends Object
implements Comparable<LevelOrderPair>

A pair denoting the level and the order of an extracted statement.

Author:

themis

Field Summary

Fields

Modifier and Type	Field and Description
int	level The level of this pair.
int	order The order of this pair.

Constructor Summary

Constructors

Constructor and Description
LevelOrderPair(int level, int order) Initializes this pair with a level and an order.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LevelOrderPair otherLevelOrderPair) Compares this object with the specified object, comparing first the order and the level of the objects.
boolean	equals(Object otherLevelOrderPair) Indicates whether the given pair is equal to this one, i.e.
int	hashCode() Returns a hash code value for this pair given its level and order, to be used in hashmaps.
String	toString() Returns a string representation of this pair.

Methods inherited from class java.lang.Object

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

Field Detail

level

public final int level

The level of this pair.

order

public final int order

The order of this pair.

Constructor Detail

LevelOrderPair

public LevelOrderPair(int level,
                      int order)

Initializes this pair with a level and an order.

Parameters:

level - the level of the pair.

order - the order of the pair.

Method Detail

hashCode

public int hashCode()

Returns a hash code value for this pair given its level and order, to be used in hashmaps.

Overrides:

hashCode in class Object

Returns:

a hash code value for this pair.

equals

public boolean equals(Object otherLevelOrderPair)

Indicates whether the given pair is equal to this one, i.e. if their levels and orders are equal.

Overrides:

equals in class Object

Parameters:

otherLevelOrderPair - the given object to be compared to this one.

Returns:

true this pair is equal to the given one, or false otherwise.

toString

public String toString()

Returns a string representation of this pair.

Overrides:

toString in class Object

Returns:

a string representation of this pair.

compareTo

public int compareTo(LevelOrderPair otherLevelOrderPair)

Compares this object with the specified object, comparing first the order and the level of the objects. This function is used for sorting.

Specified by:

compareTo in interface Comparable<LevelOrderPair>

Parameters:

otherLevelOrderPair - the given object to be compared to this one.

Returns:

1 if this pair is larger than the given one, -1 if it is smaller, or 0 if the two objects are equal.