View Javadoc

1   /**
2    * Copyright 2010-2012 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.codehaus.mojo.license.header;
17  
18  import org.apache.maven.plugin.logging.Log;
19  import org.codehaus.mojo.license.header.transformer.FileHeaderTransformer;
20  
21  /**
22   * Contract of required configuration of the {@link FileHeaderProcessor}.
23   *
24   * @author tchemit <chemit@codelutin.com>
25   * @since 1.0
26   */
27  public interface FileHeaderProcessorConfiguration
28  {
29  
30      /**
31       * @return mojo logger
32       */
33      Log getLog();
34  
35      /**
36       * @return the current file header to use
37       */
38      FileHeader getFileHeader();
39  
40      /**
41       * @return the current file transformer to use
42       */
43      FileHeaderTransformer getTransformer();
44  
45  }