edu.umd.cloud9.io.triple
Class TripleOfInts

java.lang.Object
  edu.umd.cloud9.io.triple.TripleOfInts

All Implemented Interfaces:

Comparable<TripleOfInts>, Writable, WritableComparable<TripleOfInts>

public class TripleOfInts
extends Object
implements WritableComparable<TripleOfInts>

WritableComparable representing a pair of integers. The elements in the pair are referred to as the left and right elements. The natural sort order is: first by the left element, and then by the right element.

Author:

Ke Zhai

Nested Class Summary

static class

TripleOfInts.Comparator Comparator optimized for TripleOfInts.

Constructor Summary

TripleOfInts()
Creates a TripleOnInts object.

TripleOfInts(int left, int middle, int right)
Creates a TripleOnInts object.

Method Summary

TripleOfInts	clone() Clones this object.
int	compareTo(TripleOfInts obj) Defines a natural sort order for pairs.
boolean	equals(Object obj) Checks for equality.
int	getLeftElement() Returns the left element.
int	getMiddleElement() Returns the middle element.
int	getRightElement() Returns the right element.
int	hashCode() Returns a hash code value for this ThreeInts instance.
void	readFields(DataInput in) Deserializes this object.
void	set(int left, int middle, int right) Sets the elements of this triple.
String	toString() Generates human-readable String representation of this pair.
void	write(DataOutput out) Serializes this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TripleOfInts

public TripleOfInts()

Creates a TripleOnInts object.

TripleOfInts

public TripleOfInts(int left,
                    int middle,
                    int right)

Creates a TripleOnInts object.

Parameters:

left - the left element

middle - the middle element

right - the right element

Method Detail

readFields

public void readFields(DataInput in)
                throws IOException

Deserializes this object.

Specified by:

readFields in interface Writable

Parameters:

in - source for raw byte representation

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Serializes this object.

Specified by:

write in interface Writable

Parameters:

out - where to write the raw byte representation

Throws:

IOException

getLeftElement

public int getLeftElement()

Returns the left element.

Returns:

the left element

getMiddleElement

public int getMiddleElement()

Returns the middle element.

Returns:

the middle element

getRightElement

public int getRightElement()

Returns the right element.

Returns:

the right element

set

public void set(int left,
                int middle,
                int right)

Sets the elements of this triple.

Parameters:

left - the left element

middle - the middle element

right - the right element

equals

public boolean equals(Object obj)

Checks for equality.

Overrides:

equals in class Object

Parameters:

obj - object for comparison

Returns:

true if obj is equal to this object, false otherwise

compareTo

public int compareTo(TripleOfInts obj)

Defines a natural sort order for pairs. Pairs are sorted first by the left element, and then by the right element.

Specified by:

compareTo in interface Comparable<TripleOfInts>

Returns:

a value less than zero, a value greater than zero, or zero if this pair should be sorted before, sorted after, or is equal to obj.

hashCode

public int hashCode()

Returns a hash code value for this ThreeInts instance.

Overrides:

hashCode in class Object

Returns:

hash code for this ThreeInts instance

toString

public String toString()

Generates human-readable String representation of this pair.

Overrides:

toString in class Object

Returns:

human-readable String representation of this pair

clone

public TripleOfInts clone()

Clones this object.

Overrides:

clone in class Object

Returns:

clone of this object