PngCruncher.java

/*
 * Copyright (C) 2014 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.ide.common.internal;

import com.android.annotations.NonNull;

import java.io.File;
import java.io.IOException;

/**
 * An object able to crunch a png.
 */
public interface PngCruncher {

    /**
     * Crunch a given file into another given file. This may be implemented synchronously or
     * asynchronously. Therefore the output file may not be present until {@link #end()} is called
     * and returned. When implemented asynchronously, this act like queueing a crunching request.
     * So {@link #crunchPng(java.io.File, java.io.File)} can be called multiple times and when
     * {@link #end()} is called and returned, all output files will be present.
     *
     * @param from the file to crunch
     * @param to the output file
     *
     * @throws java.io.IOException
     * @throws InterruptedException
     * @throws com.android.ide.common.internal.LoggedErrorException
     */
    void crunchPng(@NonNull File from, @NonNull File to)
            throws InterruptedException, LoggedErrorException, IOException;

    /**
     * Wait until all Png crunching requests have been executed.
     *
     * @throws InterruptedException
     */
    void end() throws InterruptedException;
}