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

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

boolean	isUpdateCopyright()
void	setUpdateCopyright(boolean updateCopyright)
protected String	treateHeader(String ch) The logic to implements when a header was touched.

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

updateCopyright

protected boolean updateCopyright

Constructor Detail

UpdateFileHeaderFilter

public UpdateFileHeaderFilter()

Method Detail

treateHeader

protected String treateHeader(String ch)

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)