org.codehaus.mojo.license.header

Class FileHeaderProcessor

java.lang.Object

org.nuiton.processor.Processor

org.codehaus.mojo.license.header.FileHeaderProcessor

@Component(role=org.nuiton.processor.Processor.class,
           hint="file-header")
public class FileHeaderProcessor
extends org.nuiton.processor.Processor

File header processor.

Since:

1.0

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
protected FileHeaderProcessorConfiguration	configuration processor configuration.
protected FileHeaderFilter	filter internal file header filter.

Fields inherited from class org.nuiton.processor.Processor

inputFilter, outputFilter

Constructor Summary

Constructors

Constructor and Description
FileHeaderProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkInit()
FileHeaderProcessorConfiguration	getConfiguration()
protected FileHeader	getFileHeader()
FileHeaderFilter	getFilter()
protected FileHeaderTransformer	getTransformer()
boolean	isDetectHeader()
boolean	isModified()
boolean	isTouched()
void	populateFilter()
void	process(File filein, File fileout)
void	reset()
void	setConfiguration(FileHeaderProcessorConfiguration configuration)
void	setFilter(FileHeaderFilter filter)

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

Field Detail

configuration

protected FileHeaderProcessorConfiguration configuration

processor configuration.

filter

protected FileHeaderFilter filter

internal file header filter.

Constructor Detail

FileHeaderProcessor

public FileHeaderProcessor()

Method Detail

getConfiguration

public FileHeaderProcessorConfiguration getConfiguration()

getFilter

public FileHeaderFilter getFilter()

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(File filein,
           File fileout)
             throws IOException

Throws:

IOException

populateFilter

public void populateFilter()

setConfiguration

public void setConfiguration(FileHeaderProcessorConfiguration configuration)

setFilter

public void setFilter(FileHeaderFilter filter)

reset

public void reset()

getFileHeader

protected FileHeader getFileHeader()

getTransformer

protected FileHeaderTransformer getTransformer()

checkInit

protected void checkInit()