src/main/java/com/android/tools/build/apkzlib/zip/Compressor.java

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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.android.tools.build.apkzlib.zip;

import com.android.tools.build.apkzlib.zip.utils.CloseableByteSource;
import com.google.common.util.concurrent.ListenableFuture;
import javax.annotation.Nonnull;

/**
 * A compressor is capable of, well, compressing data. Data is read from an {@code ByteSource}.
 * Compressors are asynchronous: compressing results in a {@code ListenableFuture} that will contain
 * the compression result.
 */
public interface Compressor {

    /**
     * Compresses an entry source.
     *
     * @param source the source to compress
     * @return a future that will eventually contain the compression result
     */
    @Nonnull
    ListenableFuture<CompressionResult> compress(@Nonnull CloseableByteSource source);
}