Serialization.java

/**
 * Copyright 2011-2017 Asakusa Framework Team.
 *
 * 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 com.asakusafw.utils.io;

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

/**
 * An abstract super interface of object serialization facilities.
 * @param <T> target object type
 * @since 0.6.0
 */
public interface Serialization<T> {

    /**
     * Creates a new {@link Source} using the {@link InputStream}.
     * @param stream the {@link InputStream} which contains serialized form
     * @return the {@link Source}
     * @throws IOException if failed to create a source by I/O error
     * @throws InterruptedException if interrupted while preparing the source
     */
    Source<T> createSource(InputStream stream) throws IOException, InterruptedException;

    /**
     * Creates a new {@link Sink} using the {@link OutputStream}.
     * @param stream the {@link OutputStream} which contains serialized form
     * @return the {@link Sink}
     * @throws IOException if failed to create a sink by I/O error
     * @throws InterruptedException if interrupted while preparing the sink
     */
    Sink<T> createSink(OutputStream stream) throws IOException, InterruptedException;
}