edu.umd.cloud9.io.triple
Class TripleOfIntsString

java.lang.Object
  extended by edu.umd.cloud9.io.triple.TripleOfIntsString
All Implemented Interfaces:
Comparable<TripleOfIntsString>, Writable, WritableComparable<TripleOfIntsString>

public class TripleOfIntsString
extends Object
implements WritableComparable<TripleOfIntsString>

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:
Jimmy Lin

Nested Class Summary
static class TripleOfIntsString.Comparator
          Comparator optimized for PairOfInts.
 
Constructor Summary
TripleOfIntsString()
          Creates a ThreeInts instance.
TripleOfIntsString(int left, int middle, String right)
          Creates a pair.
 
Method Summary
 TripleOfIntsString clone()
          Clones this object.
 int compareTo(TripleOfIntsString obj)
          Defines a natural sort order for pairs.
 boolean equals(Object obj)
          Checks two ThreeInts for equality.
 int getLeftElement()
          Returns the left element.
 int getMiddleElement()
          Returns the middle element.
 String getRightElement()
          Returns the right element.
 int hashCode()
          Returns a hash code value for this ThreeInts instance.
 void readFields(DataInput in)
          Deserializes this ThreeInts instance.
 void set(int left, int middle, String right)
          Sets the right and left elements of this pair.
 String toString()
          Generates human-readable String representation of this pair.
 void write(DataOutput out)
          Serializes this ThreeInts instance.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TripleOfIntsString

public TripleOfIntsString()
Creates a ThreeInts instance.


TripleOfIntsString

public TripleOfIntsString(int left,
                          int middle,
                          String right)
Creates a pair.

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 ThreeInts instance.

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 ThreeInts instance.

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 String getRightElement()
Returns the right element.

Returns:
the right element

set

public void set(int left,
                int middle,
                String right)
Sets the right and left elements of this pair.

Parameters:
left - the left element
middle - the middle element
right - the right element

equals

public boolean equals(Object obj)
Checks two ThreeInts 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(TripleOfIntsString 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<TripleOfIntsString>
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 TripleOfIntsString clone()
Clones this object.

Overrides:
clone in class Object
Returns:
clone of this object