View Javadoc
1   package org.apache.maven.plugin.eclipse.writers.workspace;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
5    * agreements. See the NOTICE file distributed with this work for additional information regarding
6    * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance with the License. You may obtain a
8    * 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, software distributed under the License
13   * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
14   * or implied. See the License for the specific language governing permissions and limitations under
15   * the License.
16   */
17  
18  import org.apache.maven.plugin.MojoExecutionException;
19  import org.apache.maven.plugin.eclipse.WorkspaceConfiguration;
20  import org.apache.maven.plugin.logging.Log;
21  
22  /**
23   * @author Dan T. Tran
24   * @version $Id: WorkspaceWriter.java 728546 2008-12-21 22:56:51Z bentmann $
25   */
26  
27  public interface WorkspaceWriter
28  {
29      /**
30       * Init this writer.
31       * 
32       * @param log mojo logger.
33       * @param config writer configuration.
34       * @return the writer instance
35       */
36      WorkspaceWriter init( Log log, WorkspaceConfiguration config );
37  
38      /**
39       * Main method that should be implemented by the writer to do the work.
40       * 
41       * @throws MojoExecutionException
42       */
43      void write()
44          throws MojoExecutionException;
45  }