/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.nifi.provenance.journaling.journals;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

public interface CompressionCodec {
    /**
     * Returns the name of the compression codec
     * @return
     */
    String getName();
    
    /**
     * Wraps the given OutputStream so that data written will be compressed
     * @param out
     * @return
     * @throws IOException
     */
    CompressedOutputStream newCompressionOutputStream(OutputStream out) throws IOException;
    
    /**
     * Wraps the given InputStream so that data read will be decompressed
     * @param in
     * @return
     * @throws IOException
     */
    InputStream newCompressionInputStream(InputStream in) throws IOException;
}