org.apache.flink.types

Class DoubleValue

java.lang.Object

org.apache.flink.types.DoubleValue

All Implemented Interfaces:

Serializable, Comparable<DoubleValue>, IOReadableWritable, CopyableValue<DoubleValue>, Key<DoubleValue>, ResettableValue<DoubleValue>, Value

@Public
public class DoubleValue
extends Object
implements Comparable<DoubleValue>, ResettableValue<DoubleValue>, CopyableValue<DoubleValue>, Key<DoubleValue>

Boxed serializable and comparable double precision floating point type, representing the primitive type double.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DoubleValue() Initializes the encapsulated double with 0.0.
DoubleValue(double value) Initializes the encapsulated double with the provided value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DoubleValue o)
DoubleValue	copy() Performs a deep copy of this object into a new instance.
void	copy(DataInputView source, DataOutputView target) Copies the next serialized instance from source to target.
void	copyTo(DoubleValue target) Performs a deep copy of this object into the target instance.
boolean	equals(Object obj) Compares the object on equality with another object.
int	getBinaryLength() Gets the length of the data type when it is serialized, in bytes.
double	getValue() Returns the value of the encapsulated primitive double.
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	setValue(double value) Sets the value of the encapsulated primitive double.
void	setValue(DoubleValue value) Sets the encapsulated value to another 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

DoubleValue

public DoubleValue()

Initializes the encapsulated double with 0.0.

DoubleValue

public DoubleValue(double value)

Initializes the encapsulated double with the provided value.

Parameters:

value - Initial value of the encapsulated double.

Method Detail

getValue

public double getValue()

Returns the value of the encapsulated primitive double.

Returns:

the value of the encapsulated primitive double.

setValue

public void setValue(double value)

Sets the value of the encapsulated primitive double.

Parameters:

value - the new value of the encapsulated primitive double.

setValue

public void setValue(DoubleValue value)

Description copied from interface: ResettableValue

Sets the encapsulated value to another value

Specified by:

setValue in interface ResettableValue<DoubleValue>

Parameters:

value - the new value of the encapsulated value

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

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(DoubleValue o)

Specified by:

compareTo in interface Comparable<DoubleValue>

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<DoubleValue>

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<DoubleValue>

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.

getBinaryLength

public int getBinaryLength()

Description copied from interface: CopyableValue

Gets the length of the data type when it is serialized, in bytes.

Specified by:

getBinaryLength in interface CopyableValue<DoubleValue>

Returns:

The length of the data type, or -1, if variable length.

copyTo

public void copyTo(DoubleValue target)

Description copied from interface: CopyableValue

Performs a deep copy of this object into the target instance.

Specified by:

copyTo in interface CopyableValue<DoubleValue>

Parameters:

target - Object to copy into.

copy

public DoubleValue copy()

Description copied from interface: CopyableValue

Performs a deep copy of this object into a new instance.

This method is useful for generic user-defined functions to clone a CopyableValue when storing multiple objects. With object reuse a deep copy must be created and type erasure prevents calling new.

Specified by:

copy in interface CopyableValue<DoubleValue>

Returns:

New object with copied fields.

copy

public void copy(DataInputView source,
                 DataOutputView target)
          throws IOException

Description copied from interface: CopyableValue

Copies the next serialized instance from source to target.

This method is equivalent to calling IOReadableWritable.read(DataInputView) followed by IOReadableWritable.write(DataOutputView) but does not require intermediate deserialization.

Specified by:

copy in interface CopyableValue<DoubleValue>

Parameters:

source - Data source for serialized instance.

target - Data target for serialized instance.

Throws:

IOException

See Also:

IOReadableWritable