org.apache.flink.types

Class Pair<U extends Key<U>,V extends Key<V>>

java.lang.Object

org.apache.flink.types.Pair<U,V>

Type Parameters:

U - Type of the pair's first element.

V - Type of the pair's second element.

All Implemented Interfaces:

Serializable, Comparable<Pair<U,V>>, IOReadableWritable, Key<Pair<U,V>>, Value

@PublicEvolving
public abstract class Pair<U extends Key<U>,V extends Key<V>>
extends Object
implements Key<Pair<U,V>>

Generic pair base type.

See Also:

Key, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pair() Initializes both encapsulated pair elements with empty objects.
Pair(U first, V second) Initializes the encapsulated pair elements with the provided values.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<U,V> o)
boolean	equals(Object obj) Compares the object on equality with another object.
U	getFirst() Returns the first encapsulated pair element.
V	getSecond() Returns the second encapsulated pair element.
int	hashCode() All keys must override the hash-code function to generate proper deterministic hash codes, based on their contents.
void	read(DataInputView in) Reads the object's internal data from the given data input view.
void	setFirst(U first) Sets the first encapsulated pair element to the specified value.
void	setSecond(V second) Sets the second encapsulated pair element to the specified value.
String	toString()
void	write(DataOutputView out) Writes the object's internal data to the given data output view.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair()

Initializes both encapsulated pair elements with empty objects.

Pair

public Pair(U first,
            V second)

Initializes the encapsulated pair elements with the provided values.

Parameters:

first - Initial value of the first encapsulated pair element.

second - Initial value of the second encapsulated pair element.

Method Detail

getFirst

public U getFirst()

Returns the first encapsulated pair element.

Returns:

The first encapsulated pair element.

setFirst

public void setFirst(U first)

Sets the first encapsulated pair element to the specified value.

Parameters:

first - The new value of the first encapsulated pair element.

getSecond

public V getSecond()

Returns the second encapsulated pair element.

Returns:

The second encapsulated pair element.

setSecond

public void setSecond(V second)

Sets the second encapsulated pair element to the specified value.

Parameters:

second - The new value of the second encapsulated pair element.

toString

public String toString()

Overrides:

toString in class Object

read

public void read(DataInputView in)
          throws IOException

Description copied from interface: IOReadableWritable

Reads the object's internal data from the given data input view.

Specified by:

read in interface IOReadableWritable

Parameters:

in - the input view to read the data from

Throws:

IOException - thrown if any error occurs while reading from the input stream

write

public void write(DataOutputView out)
           throws IOException

Description copied from interface: IOReadableWritable

Writes the object's internal data to the given data output view.

Specified by:

write in interface IOReadableWritable

Parameters:

out - the output view to receive the data.

Throws:

IOException - thrown if any error occurs while writing to the output stream

compareTo

public int compareTo(Pair<U,V> o)

Specified by:

compareTo in interface Comparable<Pair<U extends Key<U>,V extends Key<V>>>

hashCode

public int hashCode()

Description copied from interface: Key

All keys must override the hash-code function to generate proper deterministic hash codes, based on their contents.

Specified by:

hashCode in interface Key<Pair<U extends Key<U>,V extends Key<V>>>

Overrides:

hashCode in class Object

Returns:

The hash code of the key

equals

public boolean equals(Object obj)

Description copied from interface: Key

Compares the object on equality with another object.

Specified by:

equals in interface Key<Pair<U extends Key<U>,V extends Key<V>>>

Overrides:

equals in class Object

Parameters:

obj - The other object to compare against.

Returns:

True, iff this object is identical to the other object, false otherwise.