1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugin.eclipse.writers;
20
21 import org.apache.maven.plugin.MojoExecutionException;
22 import org.apache.maven.plugin.logging.Log;
23
24 /**
25 * @author Fabrizio Giustina
26 * @version $Id: EclipseWriter.java 595476 2007-11-15 22:21:55Z aheritier $
27 */
28 public interface EclipseWriter
29 {
30 /**
31 * Init this writer.
32 *
33 * @param log mojo logger.
34 * @param config writer configuration.
35 * @return the writer instance
36 */
37 EclipseWriter init( Log log, EclipseWriterConfig config );
38
39 /**
40 * Main method that should be implemented by the writer to do the work.
41 *
42 * @throws MojoExecutionException
43 */
44 void write()
45 throws MojoExecutionException;
46 }