com.adobe.granite.ui.clientlibs.script.ScriptTransformer Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2012 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.granite.ui.clientlibs.script;

import java.io.IOException;
import java.util.Collection;
import java.util.Map;

import javax.annotation.Nonnull;

import org.osgi.annotation.versioning.ConsumerType;
import com.adobe.granite.ui.clientlibs.HtmlLibrary;

/**
 * {@code ScriptTransformer} is an extension to the script processor which operates on script collections.
 */
@ConsumerType
public interface ScriptTransformer extends ScriptProcessor {

    /**
     * Processes the given input using the options.
     *
     * @param library the library that is processed
     * @param sources input sources
     * @param options processing options.
     * @return The processed sources or {@code sources} if not modified.
     * @throws IOException if an I/O error occurs
     */
    @Nonnull
    Collection process(@Nonnull HtmlLibrary library, @Nonnull Collection sources,
                                       @Nonnull Map options)
            throws IOException;
}