/*
 * 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.lucene.codecs.compressing;

import java.io.Closeable;
import java.io.IOException;
import org.apache.lucene.store.ByteBuffersDataInput;
import org.apache.lucene.store.DataOutput;

/** A data compressor. */
public abstract class Compressor implements Closeable {

  /** Sole constructor, typically called from sub-classes. */
  protected Compressor() {}

  /**
   * Compress bytes into <code>out</code>. It is the responsibility of the compressor to add all
   * necessary information so that a {@link Decompressor} will know when to stop decompressing bytes
   * from the stream.
   */
  public abstract void compress(ByteBuffersDataInput buffersInput, DataOutput out)
      throws IOException;
}
