org.apache.maven.plugin.eclipse.writers.EclipseWriter Maven / Gradle / Ivy

Go to download

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

The Eclipse Plugin is used to generate Eclipse IDE files (.project, .classpath and the .settings folder) from a POM.

There is a newer version: 2.10

/*
 * 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.maven.plugin.eclipse.writers;

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

/**
 * @author Fabrizio Giustina
 * @version $Id: EclipseWriter.java 595476 2007-11-15 22:21:55Z aheritier $
 */
public interface EclipseWriter
{
    /**
     * Init this writer.
     * 
     * @param log mojo logger.
     * @param config writer configuration.
     * @return the writer instance
     */
    EclipseWriter init( Log log, EclipseWriterConfig config );

    /**
     * Main method that should be implemented by the writer to do the work.
     * 
     * @throws MojoExecutionException
     */
    void write()
        throws MojoExecutionException;
}