org.codehaus.mojo.license.header

Class FileHeaderProcessor

java.lang.Object

org.nuiton.processor.Processor

org.codehaus.mojo.license.header.FileHeaderProcessor

public class FileHeaderProcessor
extends org.nuiton.processor.Processor

File header processor.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Field Summary

Fields inherited from class org.nuiton.processor.Processor

inputFilter, outputFilter

Constructor Summary

Constructors

Constructor and Description
FileHeaderProcessor(FileHeaderFilter filter, FileHeader fileHeader, FileHeaderTransformer transformer)

Method Summary

Modifier and Type	Method and Description
String	addHeader(String content)
String	getFileHeaderDescription()
boolean	isDetectHeader()
boolean	isModified()
boolean	isTouched()
void	process(String inputContent, File outputFile, String encoding)
void	updateDescription(String description)

Methods inherited from class org.nuiton.processor.Processor

getReader, process, setInputFilter, setInputFilter, setOutputFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileHeaderProcessor

public FileHeaderProcessor(FileHeaderFilter filter,
                           FileHeader fileHeader,
                           FileHeaderTransformer transformer)

Method Detail

addHeader

public String addHeader(String content)

isTouched

public boolean isTouched()

Returns:

true if processed file was touched (says the header was fully found), false otherwise

See Also:

FileHeaderFilter.isTouched()

isModified

public boolean isModified()

Returns:

true if processed file was modified (says the header was fully found and content changed), false otherwise

See Also:

FileHeaderFilter.isModified()

isDetectHeader

public boolean isDetectHeader()

Returns:

true if header of header was detected

See Also:

FileHeaderFilter.isDetectHeader()

process

public void process(String inputContent,
                    File outputFile,
                    String encoding)
             throws IOException

Throws:

IOException

getFileHeaderDescription

public String getFileHeaderDescription()

updateDescription

public void updateDescription(String description)