001    /*
002     * #%L
003     * License Maven Plugin
004     * 
005     * $Id: FileHeaderProcessorConfiguration.java 13519 2011-02-05 09:32:50Z tchemit $
006     * $HeadURL: http://svn.codehaus.org/mojo/tags/license-maven-plugin-1.0/src/main/java/org/codehaus/mojo/license/header/FileHeaderProcessorConfiguration.java $
007     * %%
008     * Copyright (C) 2008 - 2011 CodeLutin, Codehaus, Tony Chemit
009     * %%
010     * This program is free software: you can redistribute it and/or modify
011     * it under the terms of the GNU Lesser General Public License as 
012     * published by the Free Software Foundation, either version 3 of the 
013     * License, or (at your option) any later version.
014     * 
015     * This program is distributed in the hope that it will be useful,
016     * but WITHOUT ANY WARRANTY; without even the implied warranty of
017     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
018     * GNU General Lesser Public License for more details.
019     * 
020     * You should have received a copy of the GNU General Lesser Public 
021     * License along with this program.  If not, see
022     * <http://www.gnu.org/licenses/lgpl-3.0.html>.
023     * #L%
024     */
025    
026    package org.codehaus.mojo.license.header;
027    
028    import org.apache.maven.plugin.logging.Log;
029    import org.codehaus.mojo.license.header.transformer.FileHeaderTransformer;
030    
031    /**
032     * Contract of required configuration of the {@link FileHeaderProcessor}.
033     *
034     * @author tchemit <chemit@codelutin.com>
035     * @since 1.0
036     */
037    public interface FileHeaderProcessorConfiguration
038    {
039    
040        /**
041         * @return mojo logger
042         */
043        Log getLog();
044    
045        /**
046         * @return the current file header to use
047         */
048        FileHeader getFileHeader();
049    
050        /**
051         * @return the current file transformer to use
052         */
053        FileHeaderTransformer getTransformer();
054    
055    }