Package io.deephaven.tuple

Class ArrayTuple

java.lang.Object

io.deephaven.tuple.ArrayTuple

All Implemented Interfaces:

CanonicalizableTuple<ArrayTuple>, StreamingExternalizable, Externalizable, Serializable, Comparable<ArrayTuple>

public class ArrayTuple
extends Object
implements Comparable<ArrayTuple>, Externalizable, StreamingExternalizable, CanonicalizableTuple<ArrayTuple>

N-Tuple key class backed by an array of elements.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ArrayTuple()	This is required for Externalizable support, but should not be used otherwise.
ArrayTuple(Object... elements)	Construct a tuple backed by the supplied array of elements.

Method Summary

Modifier and Type	Method	Description
ArrayTuple	canonicalize(@NotNull UnaryOperator<Object> canonicalizer)	Canonicalize this tuple.
final int	compareTo(@NotNull ArrayTuple other)
Stream<Object>	elementStream()	Get the elements of this tuple as a Stream.
final boolean	equals(Object other)
final <T> T	getElement(int elementIndex)
final Object[]	getElements()	Return a new array of the elements of this tuple, safe for any use.
final int	hashCode()
void	readExternal(@NotNull ObjectInput in)
void	readExternalStreaming(@NotNull ObjectInput in, @NotNull gnu.trove.map.TIntObjectMap<SerializationUtils.Reader> cachedReaders)	Alternative to Externalizable.readExternal(ObjectInput) for use when a series of tuples of the same type with the same element types are being read in iterative fashion.
String	toString()
void	writeExternal(@NotNull ObjectOutput out)
void	writeExternalStreaming(@NotNull ObjectOutput out, @NotNull gnu.trove.map.TIntObjectMap<SerializationUtils.Writer> cachedWriters)	Alternative to Externalizable.writeExternal(ObjectOutput) for use when a series of tuples of the same type with the same element types are being written in iterative fashion.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.tuple.serialization.StreamingExternalizable

initializeExternalStreaming

Constructor Details

ArrayTuple

public ArrayTuple(Object... elements)

Construct a tuple backed by the supplied array of elements. The elements array should not be changed after this call.

Parameters:

elements - The array to wrap

ArrayTuple

public ArrayTuple()

This is required for Externalizable support, but should not be used otherwise.

Method Details

getElement

public final <T> T getElement(int elementIndex)

getElements

public final Object[] getElements()

Return a new array of the elements of this tuple, safe for any use.

Returns:

A new array of the elements of this tuple

elementStream

public Stream<Object> elementStream()

Get the elements of this tuple as a Stream.

Returns:

A new Stream of the elements of this tuple

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

compareTo

public final int compareTo(@NotNull
 @NotNull ArrayTuple other)

Specified by:

compareTo in interface Comparable<ArrayTuple>

writeExternal

public void writeExternal(@NotNull
 @NotNull ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(@NotNull
 @NotNull ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternalStreaming

public void writeExternalStreaming(@NotNull
 @NotNull ObjectOutput out,
 @NotNull
 @NotNull gnu.trove.map.TIntObjectMap<SerializationUtils.Writer> cachedWriters)
                            throws IOException

Description copied from interface: StreamingExternalizable

Alternative to Externalizable.writeExternal(ObjectOutput) for use when a series of tuples of the same type with the same element types are being written in iterative fashion.

Primitive elements should be written with their primitive write methods (e.g. DataOutput.writeInt(int)).

Object elements are preceded by a boolean, true if null, false otherwise. The first non-null value for a given Object element is then preceded by the name of the class. All non-null values are then written with a writer method from SerializationUtils.getWriter(Class, ObjectOutput), cached in cachedWriters.

Specified by:

writeExternalStreaming in interface StreamingExternalizable

Parameters:

out - The output

cachedWriters - The cached writers

Throws:

IOException

readExternalStreaming

public void readExternalStreaming(@NotNull
 @NotNull ObjectInput in,
 @NotNull
 @NotNull gnu.trove.map.TIntObjectMap<SerializationUtils.Reader> cachedReaders)
                           throws Exception

Description copied from interface: StreamingExternalizable

Alternative to Externalizable.readExternal(ObjectInput) for use when a series of tuples of the same type with the same element types are being read in iterative fashion.

Primitive elements should be read with their primitive read methods (e.g. DataInput.readInt()).

Object elements are preceded by a boolean, true if null, false otherwise. The first non-null value for a given Object element is then preceded by the name of the class. All non-null values are then read with a reader method from SerializationUtils.getReader(Class, ObjectInput), cached in cachedReaders.

Specified by:

readExternalStreaming in interface StreamingExternalizable

Parameters:

in - The input

cachedReaders - The cached readers

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

canonicalize

public ArrayTuple canonicalize(@NotNull
 @NotNull UnaryOperator<Object> canonicalizer)

Description copied from interface: CanonicalizableTuple

Canonicalize this tuple.

Specified by:

canonicalize in interface CanonicalizableTuple<ArrayTuple>

Parameters:

canonicalizer - The canonicalization operator to use on each object element.

Returns:

This tuple if already canonical, else a new, canonical tuple of the same type