Package org.codehaus.mojo.license.header
Class FileHeaderFilter
java.lang.Object
org.nuiton.processor.filters.DefaultFilter
org.codehaus.mojo.license.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:
- 1.0
- Author:
- tchemit dev@tchemit.fr
-
Nested Class Summary
Nested classes/interfaces inherited from class org.nuiton.processor.filters.DefaultFilter
org.nuiton.processor.filters.DefaultFilter.State
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
flag set totrue
as soon as start process tag was detected.protected FileHeader
incoming default file header model.protected String
cached full header content (with process tag + comment box).protected String
cached header content.protected boolean
flag set totrue
when a header was detected and was modified.protected String
cached full header content (with process tag + comment box).protected boolean
flag set totrue
when a header was detected (says detects both start and end process tags).protected FileHeaderTransformer
header transformer.Fields inherited from class org.nuiton.processor.filters.DefaultFilter
cachedContent, NOT_FOUND, reader, state
Fields inherited from interface org.nuiton.processor.filters.Filter
EMPTY_STRING
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
changeState
(org.nuiton.processor.filters.DefaultFilter.State newState) protected String
protected String
protected abstract FileHeader
getNewHeader
(FileHeader oldHeader) Obtains the new header to use according to the old one.boolean
boolean
boolean
protected String
protected String
void
reset()
void
void
setFileHeader
(FileHeader fileHeader) void
setTransformer
(FileHeaderTransformer transformer) Methods inherited from class org.nuiton.processor.filters.DefaultFilter
flush, getLineNumber, getMatchIndexFor, getMatchLengthFor, hasCachedData, parse, performHeaderFooterFilter, setReader
-
Field Details
-
touched
protected boolean touchedflag set totrue
when a header was detected (says detects both start and end process tags). -
modified
protected boolean modifiedflag set totrue
when a header was detected and was modified. -
detectHeader
protected boolean detectHeaderflag set totrue
as soon as start process tag was detected. -
fileHeader
incoming default file header model. -
transformer
header transformer. -
headerContent
cached header content. -
processTagHeaderContent
cached full header content (with process tag + comment box). -
fullHeaderContent
cached full header content (with process tag + comment box).
-
-
Constructor Details
-
FileHeaderFilter
public FileHeaderFilter()Default constructor.
-
-
Method Details
-
getNewHeader
Obtains the new header to use according to the old one. Note: If the new header should not be updated, then the result isnull
.- Parameters:
oldHeader
- the old header found in file.- Returns:
null
if header is still the same, otherwise the new header to apply- Since:
- 1.0
-
performInFilter
- Specified by:
performInFilter
in classorg.nuiton.processor.filters.DefaultFilter
-
performOutFilter
- Specified by:
performOutFilter
in classorg.nuiton.processor.filters.DefaultFilter
-
getHeader
- Specified by:
getHeader
in classorg.nuiton.processor.filters.DefaultFilter
-
changeState
protected void changeState(org.nuiton.processor.filters.DefaultFilter.State newState) - Overrides:
changeState
in classorg.nuiton.processor.filters.DefaultFilter
-
getHeaderContent
-
getProcessTagHeaderContent
-
getFullHeaderContent
-
isTouched
public boolean isTouched() -
isModified
public boolean isModified() -
isDetectHeader
public boolean isDetectHeader() -
getFileHeader
-
getTransformer
-
setFileHeader
-
setTransformer
-
reset
public void reset() -
resetContent
public void resetContent()
-