001 /**
002 * Copyright 2010-2012 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.codehaus.mojo.license.header;
017
018 import org.apache.maven.plugin.logging.Log;
019 import org.codehaus.mojo.license.header.transformer.FileHeaderTransformer;
020
021 /**
022 * Contract of required configuration of the {@link FileHeaderProcessor}.
023 *
024 * @author tchemit <chemit@codelutin.com>
025 * @since 1.0
026 */
027 public interface FileHeaderProcessorConfiguration
028 {
029
030 /**
031 * @return mojo logger
032 */
033 Log getLog();
034
035 /**
036 * @return the current file header to use
037 */
038 FileHeader getFileHeader();
039
040 /**
041 * @return the current file transformer to use
042 */
043 FileHeaderTransformer getTransformer();
044
045 }