org.apache.flink.api.common.typeutils.base.array

Class CharPrimitiveArraySerializer

java.lang.Object

org.apache.flink.api.common.typeutils.TypeSerializer<T>

org.apache.flink.api.common.typeutils.base.TypeSerializerSingleton<char[]>

org.apache.flink.api.common.typeutils.base.array.CharPrimitiveArraySerializer

All Implemented Interfaces:

Serializable

@Internal
public final class CharPrimitiveArraySerializer
extends TypeSerializerSingleton<char[]>

A serializer for char arrays.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CharPrimitiveArraySerializer	INSTANCE

Constructor Summary

Constructors

Constructor and Description
CharPrimitiveArraySerializer()

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(Object obj) Returns true if the given object can be equaled with this object.
char[]	copy(char[] from) Creates a deep copy of the given element in a new element.
char[]	copy(char[] from, char[] reuse) Creates a copy from the given element.
void	copy(DataInputView source, DataOutputView target) Copies exactly one record from the source input view to the target output view.
char[]	createInstance() Creates a new instance of the data type.
char[]	deserialize(char[] reuse, DataInputView source) De-serializes a record from the given source input view into the given reuse record instance if mutable.
char[]	deserialize(DataInputView source) De-serializes a record from the given source input view.
int	getLength() Gets the length of the data type, if it is a fix length data type.
boolean	isImmutableType() Gets whether the type is an immutable type.
void	serialize(char[] record, DataOutputView target) Serializes the given record to the given target output view.

Methods inherited from class org.apache.flink.api.common.typeutils.base.TypeSerializerSingleton

duplicate, ensureCompatibility, equals, hashCode, isCompatibleSerializationFormatIdentifier, snapshotConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final CharPrimitiveArraySerializer INSTANCE

Constructor Detail

CharPrimitiveArraySerializer

public CharPrimitiveArraySerializer()

Method Detail

isImmutableType

public boolean isImmutableType()

Description copied from class: TypeSerializer

Gets whether the type is an immutable type.

Specified by:

isImmutableType in class TypeSerializer<char[]>

Returns:

True, if the type is immutable.

createInstance

public char[] createInstance()

Description copied from class: TypeSerializer

Creates a new instance of the data type.

Specified by:

createInstance in class TypeSerializer<char[]>

Returns:

A new instance of the data type.

copy

public char[] copy(char[] from)

Description copied from class: TypeSerializer

Creates a deep copy of the given element in a new element.

Specified by:

copy in class TypeSerializer<char[]>

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

copy

public char[] copy(char[] from,
                   char[] reuse)

Description copied from class: TypeSerializer

Creates a copy from the given element. The method makes an attempt to store the copy in the given reuse element, if the type is mutable. This is, however, not guaranteed.

Specified by:

copy in class TypeSerializer<char[]>

Parameters:

from - The element to be copied.

reuse - The element to be reused. May or may not be used.

Returns:

A deep copy of the element.

getLength

public int getLength()

Description copied from class: TypeSerializer

Gets the length of the data type, if it is a fix length data type.

Specified by:

getLength in class TypeSerializer<char[]>

Returns:

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

serialize

public void serialize(char[] record,
                      DataOutputView target)
               throws IOException

Description copied from class: TypeSerializer

Serializes the given record to the given target output view.

Specified by:

serialize in class TypeSerializer<char[]>

Parameters:

record - The record to serialize.

target - The output view to write the serialized data to.

Throws:

IOException - Thrown, if the serialization encountered an I/O related error. Typically raised by the output view, which may have an underlying I/O channel to which it delegates.

deserialize

public char[] deserialize(DataInputView source)
                   throws IOException

Description copied from class: TypeSerializer

De-serializes a record from the given source input view.

Specified by:

deserialize in class TypeSerializer<char[]>

Parameters:

source - The input view from which to read the data.

Returns:

The deserialized element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

deserialize

public char[] deserialize(char[] reuse,
                          DataInputView source)
                   throws IOException

Description copied from class: TypeSerializer

De-serializes a record from the given source input view into the given reuse record instance if mutable.

Specified by:

deserialize in class TypeSerializer<char[]>

Parameters:

reuse - The record instance into which to de-serialize the data.

source - The input view from which to read the data.

Returns:

The deserialized element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

copy

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

Description copied from class: TypeSerializer

Copies exactly one record from the source input view to the target output view. Whether this operation works on binary data or partially de-serializes the record to determine its length (such as for records of variable length) is up to the implementer. Binary copies are typically faster. A copy of a record containing two integer numbers (8 bytes total) is most efficiently implemented as target.write(source, 8);.

Specified by:

copy in class TypeSerializer<char[]>

Parameters:

source - The input view from which to read the record.

target - The target output view to which to write the record.

Throws:

IOException - Thrown if any of the two views raises an exception.

canEqual

public boolean canEqual(Object obj)

Description copied from class: TypeSerializer

Returns true if the given object can be equaled with this object. If not, it returns false.

Specified by:

canEqual in class TypeSerializer<char[]>

Parameters:

obj - Object which wants to take part in the equality relation

Returns:

true if obj can be equaled with this, otherwise false