org.apache.giraph.writable.tuple

Class PairWritable<L extends org.apache.hadoop.io.Writable,R extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.commons.lang3.tuple.Pair<L,R>

org.apache.giraph.writable.tuple.PairWritable<L,R>

Type Parameters:

L - Type of the left element

R - Type of the right element

All Implemented Interfaces:

Serializable, Comparable<org.apache.commons.lang3.tuple.Pair<L,R>>, Map.Entry<L,R>, org.apache.hadoop.io.Writable

Direct Known Subclasses:

DoubleDoubleWritable, IntDoubleWritable, IntIntWritable, IntLongWritable, LongDoubleWritable, LongIntWritable, LongLongWritable

public class PairWritable<L extends org.apache.hadoop.io.Writable,R extends org.apache.hadoop.io.Writable>
extends org.apache.commons.lang3.tuple.Pair<L,R>
implements org.apache.hadoop.io.Writable

Pair Writable class, that knows types upfront and can deserialize itself. PairWritable knows types, as instances are passed through constructor, and are references are immutable (values themselves are mutable). Child classes specify no-arg constructor that passes concrete types in. Extends Pair, not ImmutablePair, since later class is final. Code is copied from it.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PairWritable(L left, R right) Create a new pair instance.

Method Summary

Modifier and Type	Method and Description
L	getLeft()
R	getRight()
static <L extends org.apache.hadoop.io.Writable,R extends org.apache.hadoop.io.Writable> PairWritable<L,R>	of(L left, R right) Obtains an immutable pair of from two objects inferring the generic types.
void	readFields(DataInput in)
R	setValue(R value) Throws UnsupportedOperationException.
void	write(DataOutput out)

Methods inherited from class org.apache.commons.lang3.tuple.Pair

compareTo, equals, getKey, getValue, hashCode, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

PairWritable

public PairWritable(L left,
                    R right)

Create a new pair instance.

Parameters:

left - the left value

right - the right value

Method Detail

of

public static <L extends org.apache.hadoop.io.Writable,R extends org.apache.hadoop.io.Writable> PairWritable<L,R> of(L left,
                                                                                                                     R right)

Obtains an immutable pair of from two objects inferring the generic types.

This factory allows the pair to be created using inference to obtain the generic types.

Type Parameters:

L - the left element type

R - the right element type

Parameters:

left - the left element, may be null

right - the right element, may be null

Returns:

a pair formed from the two parameters, not null

getLeft

public final L getLeft()

Specified by:

getLeft in class org.apache.commons.lang3.tuple.Pair<L extends org.apache.hadoop.io.Writable,R extends org.apache.hadoop.io.Writable>

getRight

public final R getRight()

Specified by:

getRight in class org.apache.commons.lang3.tuple.Pair<L extends org.apache.hadoop.io.Writable,R extends org.apache.hadoop.io.Writable>

setValue

public final R setValue(R value)

Throws UnsupportedOperationException.

This pair is immutable, so this operation is not supported.

Specified by:

setValue in interface Map.Entry<L extends org.apache.hadoop.io.Writable,R extends org.apache.hadoop.io.Writable>

Parameters:

value - the value to set

Returns:

never

Throws:

UnsupportedOperationException - as this operation is not supported

write

public final void write(DataOutput out)
                 throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

readFields

public final void readFields(DataInput in)
                      throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException