View Javadoc

1   /*
2    * #%L
3    * License Maven Plugin
4    * 
5    * $Id: FileHeaderProcessorConfiguration.java 13519 2011-02-05 09:32:50Z tchemit $
6    * $HeadURL: http://svn.codehaus.org/mojo/tags/license-maven-plugin-1.0/src/main/java/org/codehaus/mojo/license/header/FileHeaderProcessorConfiguration.java $
7    * %%
8    * Copyright (C) 2008 - 2011 CodeLutin, Codehaus, Tony Chemit
9    * %%
10   * This program is free software: you can redistribute it and/or modify
11   * it under the terms of the GNU Lesser General Public License as 
12   * published by the Free Software Foundation, either version 3 of the 
13   * License, or (at your option) any later version.
14   * 
15   * This program is distributed in the hope that it will be useful,
16   * but WITHOUT ANY WARRANTY; without even the implied warranty of
17   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18   * GNU General Lesser Public License for more details.
19   * 
20   * You should have received a copy of the GNU General Lesser Public 
21   * License along with this program.  If not, see
22   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
23   * #L%
24   */
25  
26  package org.codehaus.mojo.license.header;
27  
28  import org.apache.maven.plugin.logging.Log;
29  import org.codehaus.mojo.license.header.transformer.FileHeaderTransformer;
30  
31  /**
32   * Contract of required configuration of the {@link FileHeaderProcessor}.
33   *
34   * @author tchemit <chemit@codelutin.com>
35   * @since 1.0
36   */
37  public interface FileHeaderProcessorConfiguration
38  {
39  
40      /**
41       * @return mojo logger
42       */
43      Log getLog();
44  
45      /**
46       * @return the current file header to use
47       */
48      FileHeader getFileHeader();
49  
50      /**
51       * @return the current file transformer to use
52       */
53      FileHeaderTransformer getTransformer();
54  
55  }