Package org.codehaus.mojo.license.header

Class UpdateFileHeaderFilter

java.lang.Object

org.nuiton.processor.filters.DefaultFilter

org.codehaus.mojo.license.header.FileHeaderFilter

org.codehaus.mojo.license.header.UpdateFileHeaderFilter

All Implemented Interfaces:

org.nuiton.processor.filters.Filter

public class UpdateFileHeaderFilter
extends FileHeaderFilter

Implementation of FileHeaderFilter to update an incoming header.

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

Fields inherited from class org.codehaus.mojo.license.header.FileHeaderFilter

detectHeader, fileHeader, fullHeaderContent, headerContent, modified, processTagHeaderContent, touched, 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

Constructors

Constructor	Description
UpdateFileHeaderFilter()

Method Summary

Modifier and Type	Method	Description
protected FileHeader	getNewHeader(FileHeader oldHeader)	Obtains the new header to use according to the old one.
void	setUpdateCopyright(boolean updateCopyright)
void	setUpdateDescription(boolean updateDescription)
void	setUpdateLicense(boolean updateLicense)

Methods inherited from class org.codehaus.mojo.license.header.FileHeaderFilter

changeState, getFileHeader, getFooter, getFullHeaderContent, getHeader, getHeaderContent, getProcessTagHeaderContent, getTransformer, isDetectHeader, isModified, isTouched, performInFilter, performOutFilter, reset, resetContent, setFileHeader, setTransformer

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

flush, getLineNumber, getMatchIndexFor, getMatchLengthFor, hasCachedData, parse, performHeaderFooterFilter, setReader

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateFileHeaderFilter

public UpdateFileHeaderFilter()

Method Details

getNewHeader

protected FileHeader getNewHeader(FileHeader oldHeader)

Description copied from class: FileHeaderFilter

Obtains the new header to use according to the old one. Note: If the new header should not be updated, then the result is null.

Specified by:

getNewHeader in class FileHeaderFilter

Parameters:

oldHeader - the old header found in file.

Returns:

null if header is still the same, otherwise the new header to apply

setUpdateCopyright

public void setUpdateCopyright(boolean updateCopyright)

setUpdateDescription

public void setUpdateDescription(boolean updateDescription)

setUpdateLicense

public void setUpdateLicense(boolean updateLicense)