org.datavec.api.io.serializers.Deserializer Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.0.0-M2.1

/*-
 *  * Copyright 2016 Skymind, Inc.
 *  *
 *  *    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 org.datavec.api.io.serializers;

import java.io.IOException;
import java.io.InputStream;

/**
 * 
 * Provides a facility for deserializing objects of type  from an
 * {@link InputStream}.
 * 
 *
 * 
 * Deserializers are stateful, but must not buffer the input since
 * other producers may read from the input between calls to
 * {@link #deserialize(Object)}.
 * 
 * @param 
 */
public interface Deserializer {
    /**
     * Prepare the deserializer for reading.
     */
    void open(InputStream in) throws IOException;

    /**
     * 
     * Deserialize the next object from the underlying input stream.
     * If the object t is non-null then this deserializer
     * may set its internal state to the next object read from the input
     * stream. Otherwise, if the object t is null a new
     * deserialized object will be created.
     * 
     * @return the deserialized object
     */
    T deserialize(T t) throws IOException;

    /**
     * Close the underlying input stream and clear up any resources.
     */
    void close() throws IOException;
}