org.nuiton.license.plugin.header
Class FileHeaderFilter

java.lang.Object
  org.nuiton.processor.filters.DefaultFilter
      org.nuiton.license.plugin.header.FileHeaderFilter

All Implemented Interfaces:

org.nuiton.processor.filters.Filter

Direct Known Subclasses:

UpdateFileHeaderFilter

public abstract class FileHeaderFilter
extends org.nuiton.processor.filters.DefaultFilter

File Header filter.

Since:

2.1

Author:

tchemit

Nested Class Summary

Nested classes/interfaces inherited from class org.nuiton.processor.filters.DefaultFilter

org.nuiton.processor.filters.DefaultFilter.State

Field Summary

protected boolean	detectHeader flag set to true as soon as start process tag was detected.
protected FileHeader	fileHeader incoming default file header model
protected String	fullHeaderContent cached full header content (with process tag + comment box)
protected String	headerContent cached header content
protected org.apache.maven.plugin.logging.Log	log maven logger
protected boolean	modified flag set to true when a header was detected and was modified.
protected String	processTagHeaderContent cached full header content (with process tag + comment box)
protected boolean	touched flag set to true when a header was detected (says detects both start and end process tags).
protected FileHeaderTransformer	transformer header transformer

Fields inherited from class org.nuiton.processor.filters.DefaultFilter

cachedContent, NOT_FOUND, state

Fields inherited from interface org.nuiton.processor.filters.Filter

EMPTY_STRING

Constructor Summary

FileHeaderFilter()

Method Summary

protected void	changeState(org.nuiton.processor.filters.DefaultFilter.State newState)
FileHeader	getFileHeader()
protected String	getFooter()
String	getFullHeaderContent()
protected String	getHeader()
String	getHeaderContent()
org.apache.maven.plugin.logging.Log	getLog()
String	getProcessTagHeaderContent()
FileHeaderTransformer	getTransformer()
boolean	isDetectHeader()
boolean	isModified()
boolean	isTouched()
protected String	performInFilter(String ch)
protected String	performOutFilter(String ch)
void	reset()
void	resetContent()
void	setFileHeader(FileHeader fileHeader)
void	setLog(org.apache.maven.plugin.logging.Log log)
void	setTransformer(FileHeaderTransformer transformer)
protected abstract String	treateHeader(String ch) The logic to implements when a header was touched.

Methods inherited from class org.nuiton.processor.filters.DefaultFilter

flush, getMatchIndexFor, getMatchLengthFor, hasCachedData, parse, performHeaderFooterFilter

Methods inherited from class java.lang.Object

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

Field Detail

touched

protected boolean touched

flag set to true when a header was detected (says detects both start and end process tags).

modified

protected boolean modified

flag set to true when a header was detected and was modified.

detectHeader

protected boolean detectHeader

flag set to true as soon as start process tag was detected.

fileHeader

protected FileHeader fileHeader

incoming default file header model

transformer

protected FileHeaderTransformer transformer

header transformer

headerContent

protected String headerContent

cached header content

processTagHeaderContent

protected String processTagHeaderContent

cached full header content (with process tag + comment box)

fullHeaderContent

protected String fullHeaderContent

cached full header content (with process tag + comment box)

log

protected org.apache.maven.plugin.logging.Log log

maven logger

Constructor Detail

FileHeaderFilter

public FileHeaderFilter()

Method Detail

treateHeader

protected abstract String treateHeader(String ch)

The logic to implements when a header was touched.

Parameters:

ch - the actual header content

Returns:

the new header content (beginning by a FileHeaderTransformer.getProcessStartTag() and ending with a FileHeaderTransformer.getProcessEndTag()).

getLog

public org.apache.maven.plugin.logging.Log getLog()

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

performInFilter

protected String performInFilter(String ch)

Specified by:

performInFilter in class org.nuiton.processor.filters.DefaultFilter

performOutFilter

protected String performOutFilter(String ch)

Specified by:

performOutFilter in class org.nuiton.processor.filters.DefaultFilter

getHeader

protected String getHeader()

Specified by:

getHeader in class org.nuiton.processor.filters.DefaultFilter

getFooter

protected String getFooter()

Specified by:

getFooter in class org.nuiton.processor.filters.DefaultFilter

changeState

protected void changeState(org.nuiton.processor.filters.DefaultFilter.State newState)

Overrides:

changeState in class org.nuiton.processor.filters.DefaultFilter

getHeaderContent

public String getHeaderContent()

getProcessTagHeaderContent

public String getProcessTagHeaderContent()

getFullHeaderContent

public String getFullHeaderContent()

isTouched

public boolean isTouched()

isModified

public boolean isModified()

isDetectHeader

public boolean isDetectHeader()

getFileHeader

public FileHeader getFileHeader()

getTransformer

public FileHeaderTransformer getTransformer()

setFileHeader

public void setFileHeader(FileHeader fileHeader)

setTransformer

public void setTransformer(FileHeaderTransformer transformer)

reset

public void reset()

resetContent

public void resetContent()