io.servicetalk.serialization.api.StreamingSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of servicetalk-serialization-api Show documentation

A networking framework that evolves with your application

There is a newer version: 0.42.52

Show newest version

/*
 * Copyright © 2018 Apple Inc. and the ServiceTalk project authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.servicetalk.serialization.api;

import io.servicetalk.buffer.api.Buffer;

/**
 * A contract capable of serializing a stream of {@link Object}s into a stream of {@link Buffer}s.
 * This interface is designed to be used as a function that can convert an {@link Object} into a {@link Buffer}.
 * {@link #serialize(Object, Buffer)} maybe called multiple times.
 * 
 *
 * A {@link StreamingSerializer} implementation may chose to be stateful or stateless. This contract does not assume
 * either.
 * Implementations are assumed to be synchronous.
 * @deprecated Use {@link io.servicetalk.serializer.api.StreamingSerializer}.
 */
@Deprecated
@FunctionalInterface
public interface StreamingSerializer {

    /**
     * Serializes the passed {@link Object} {@code toSerialize} into the passed {@link Buffer} synchronously.
     * @param toSerialize {@link Object} to serialize.
     * @param destination {@link Buffer} to which the serialized representation of {@code toSerialize} is to be written.
     * @deprecated Use {@link io.servicetalk.serializer.api.StreamingSerializer}.
     */
    @Deprecated
    void serialize(Object toSerialize, Buffer destination);
}