org.codehaus.mojo.rmic.RmiCompiler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rmic-maven-plugin Show documentation

RMI Compiler Maven Plugin

There is a newer version: 1.3

package org.codehaus.mojo.rmic;

/*
 * Copyright (c) 2004-2012, Codehaus.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import org.apache.maven.plugin.logging.Log;

import java.util.List;

/**
 * @author Trygve Laugstøl
 * @version $Id: RmiCompiler.java 17110 2012-07-11 00:14:50Z russgold $
 */
public interface RmiCompiler
{
    /**
     * Run the rmi compilation against the compiled classes.
     *
     * @param mojo
     * @param rmiConfig        The settings to be passed to the rmi compiler
     * @param classesToCompile List of class names to compile
     * @throws RmiCompilerException If there is a problem during compilation
     */
    void execute( AbstractRmiMojo mojo, RmicConfig rmiConfig, List classesToCompile )
            throws RmiCompilerException;

    /**
     * Defines the logger to use.
     */
    void setLog( Log log );

    /**
     * Returns the defined log.
     */
    Log getLog();
}