org.nuiton.license.plugin.header
Class UpdateFileHeaderFilter

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

All Implemented Interfaces:

org.nuiton.processor.filters.Filter

public class UpdateFileHeaderFilter
extends FileHeaderFilter

Implementation of FileHeaderFilter to update an incoming header.

Since:

2.1

Author:

tchemit

Plexus component:

role:

"org.nuiton.license.plugin.header.FileHeaderFilter"

role-hint:

"update-file-header"

Nested Class Summary

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

org.nuiton.processor.filters.DefaultFilter.State

Field Summary

protected boolean	updateCopyright Flag sets to true if copyright can be updated.
protected boolean	updateDescription Flag sets to true if description can be updated.
protected boolean	updateLicense Flag set to true if license can be updated.

Fields inherited from class org.nuiton.license.plugin.header.FileHeaderFilter

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

UpdateFileHeaderFilter()

Method Summary

protected FileHeader	getNewHeader(FileHeader oldHeader) Obtains the new header to use according to the old one.
boolean	isUpdateCopyright()
boolean	isUpdateDescription()
boolean	isUpdateLicense()
void	setUpdateCopyright(boolean updateCopyright)
void	setUpdateDescription(boolean updateDescription)
void	setUpdateLicense(boolean updateLicense)
protected String	treateHeader(String ch) Deprecated.

Methods inherited from class org.nuiton.license.plugin.header.FileHeaderFilter

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

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

updateDescription

protected boolean updateDescription

Flag sets to true if description can be updated.

Since:

2.3.2

updateLicense

protected boolean updateLicense

Flag set to true if license can be updated.

Since:

2.3.2

updateCopyright

protected boolean updateCopyright

Flag sets to true if copyright can be updated.

Since:

2.1

Constructor Detail

UpdateFileHeaderFilter

public UpdateFileHeaderFilter()

Method Detail

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

treateHeader

@Deprecated
protected String treateHeader(String ch)

Deprecated.

Description copied from class: FileHeaderFilter

The logic to implements when a header was touched.

Specified by:

treateHeader in class FileHeaderFilter

Parameters:

ch - the actual header content

Returns:

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

isUpdateCopyright

public boolean isUpdateCopyright()

setUpdateCopyright

public void setUpdateCopyright(boolean updateCopyright)

isUpdateDescription

public boolean isUpdateDescription()

setUpdateDescription

public void setUpdateDescription(boolean updateDescription)

isUpdateLicense

public boolean isUpdateLicense()

setUpdateLicense

public void setUpdateLicense(boolean updateLicense)