Package org.apache.flink.api.java.typeutils.runtime

Class TupleSerializer<T extends Tuple>

    • Constructor Detail

      • TupleSerializer

        public TupleSerializer​(Class<T> tupleClass,
                       TypeSerializer<?>[] fieldSerializers)

    • Method Detail

      • duplicate

        public TupleSerializer<T> duplicate()
        Description copied from class: TypeSerializer
        Creates a deep copy of this serializer if it is necessary, i.e. if it is stateful. This can return itself if the serializer is not stateful.

        We need this because Serializers might be used in several threads. Stateless serializers are inherently thread-safe while stateful serializers might not be thread-safe.

        Specified by:
        duplicate in class TypeSerializer<T extends Tuple>

      • createInstance

        public T createInstance()
        Description copied from class: TypeSerializer
        Creates a new instance of the data type.
        Specified by:
        createInstance in class TypeSerializer<T extends Tuple>
        Returns:
        A new instance of the data type.

      • copy

        public T copy​(T from)
        Description copied from class: TypeSerializer
        Creates a deep copy of the given element in a new element.
        Specified by:
        copy in class TypeSerializer<T extends Tuple>
        Parameters:
        from - The element reuse be copied.
        Returns:
        A deep copy of the element.

      • copy

        public T copy​(T from,
              T 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<T extends Tuple>
        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.

      • serialize

        public void serialize​(T value,
                      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<T extends Tuple>
        Parameters:
        value - 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 T 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<T extends Tuple>
        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 T deserialize​(T 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<T extends Tuple>
        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.

      • snapshotConfiguration

        public TypeSerializerSnapshot<T> snapshotConfiguration()
        Description copied from class: TypeSerializer
        Snapshots the configuration of this TypeSerializer. This method is only relevant if the serializer is used to state stored in checkpoints/savepoints.

        The snapshot of the TypeSerializer is supposed to contain all information that affects the serialization format of the serializer. The snapshot serves two purposes: First, to reproduce the serializer when the checkpoint/savepoint is restored, and second, to check whether the serialization format is compatible with the serializer used in the restored program.

        IMPORTANT: TypeSerializerSnapshots changed after Flink 1.6. Serializers implemented against Flink versions up to 1.6 should still work, but adjust to new model to enable state evolution and be future-proof. See the class-level comments, section "Upgrading TypeSerializers to the new TypeSerializerSnapshot model" for details.

        Specified by:
        snapshotConfiguration in class TypeSerializer<T extends Tuple>
        Returns:
        snapshot of the serializer's current configuration (cannot be null).
        See Also:
        TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializerSnapshot)