org.codehaus.mojo.license.header.transformer

Class AbstractFileHeaderTransformer

java.lang.Object

org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

All Implemented Interfaces:

FileHeaderTransformer

Direct Known Subclasses:

AptFileHeaderTransformer, FreeMarkerFileHeaderTransformer, HtmlFileHeaderTransformer, JavaFileHeaderTransformer, JspFileHeaderTransformer, MySqlFileHeaderTransformer, PhpFileHeaderTransformer, PropertiesFileHeaderTransformer, RstFileHeaderTransformer, SqlFileHeaderTransformer, XmlFileHeaderTransformer

public abstract class AbstractFileHeaderTransformer
extends Object
implements FileHeaderTransformer

Abstract implementation of FileHeaderTransformer. Concrete implementation should only have to give comment configuration.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Field Summary

Fields inherited from interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

DEFAULT_PROCESS_END_TAG, DEFAULT_PROCESS_START_TAG, DEFAULT_SECTION_DELIMITER, LINE_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileHeaderTransformer(String name, String description, String commentStartTag, String commentEndTag, String commentLinePrefix)

Method Summary

Modifier and Type	Method and Description
String	addHeader(String header, String content) Adds the header.
String	boxComment(String header, boolean withTags) Box the given header in a comment.
String	boxProcessTag(String header) Box the given header between process tags.
String	getCommentEndTag()
String	getCommentLinePrefix()
String	getCommentStartTag()
String	getDescription()
String	getLineSeparator()
String	getName()
String	getProcessEndTag() Obtain the process tag which indiciates the end of the header content.
String	getProcessStartTag() Obtains the process tag which indicates the begin of the header content.
String	getSectionDelimiter() The pattern used to separate sections of the header.
boolean	isCopyrightEquals(FileHeader header1, FileHeader header2) Tests if the copyright of the two models are equals.
boolean	isDescriptionEquals(FileHeader header1, FileHeader header2) Tests if the description of the two models are equals.
boolean	isEmptyLineAfterHeader() Get flag if there should be an empty line after the header.
boolean	isLicenseEquals(FileHeader header1, FileHeader header2) Tests if the license of the two models are equals.
boolean	isTrimHeaderLine() Get flag if header line should be right trimmed when written.
void	setCommentEndTag(String commentEndTag) Changes the comment end tag.
void	setCommentLinePrefix(String commentLinePrefix) Changes the comment prefix line.
void	setCommentStartTag(String commentStartTag) Changes the comment start tag.
void	setDescription(String description) Chages the description of the transformer.
void	setEmptyLineAfterHeader(boolean emptyLine) Set flag if there should be an empty line after the header.
void	setLineSeparator(String lineSeparator)
void	setName(String name) Changes the name of the transformer.
void	setProcessEndTag(String processEndTag) Changes the process end tag.
void	setProcessStartTag(String processStartTag) Changes the process start tag.
void	setSectionDelimiter(String sectionDelimiter) Sets the header section delimiter.
void	setTrimHeaderLine(boolean trimLine) Set flag if header line should be right trimmed when written.
FileHeader	toFileHeader(String header) Build a FileHeader from an UNBOXED header content.
String	toHeaderContent(FileHeader model) Build a fully boxed header content from the given model.
String	toString(FileHeader model) Build a UNBOXED header content from the given model.
String	unboxComent(String header) Unbox the given boxed boxedHeader to obtain the header content.
String	unboxProcessTag(String boxedHeader) Unbox the process tag on the given boxed boxedHeader to obtain the brute header content.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

getDefaultAcceptedExtensions

Constructor Detail

AbstractFileHeaderTransformer

protected AbstractFileHeaderTransformer(String name,
                                        String description,
                                        String commentStartTag,
                                        String commentEndTag,
                                        String commentLinePrefix)

Method Detail

getName

public String getName()

Specified by:

getName in interface FileHeaderTransformer

Returns:

the name of the transformer

setName

public void setName(String name)

Changes the name of the transformer.

Specified by:

setName in interface FileHeaderTransformer

Parameters:

name - the new name of the transformer

getDescription

public String getDescription()

Specified by:

getDescription in interface FileHeaderTransformer

Returns:

the description of the transformer

setDescription

public void setDescription(String description)

Chages the description of the transformer.

Specified by:

setDescription in interface FileHeaderTransformer

Parameters:

description - the new description of the transformer

getSectionDelimiter

public String getSectionDelimiter()

The pattern used to separate sections of the header. By default, (says if you do not explicitly invoke the FileHeaderTransformer.setSectionDelimiter(String) method), will use the FileHeaderTransformer.DEFAULT_SECTION_DELIMITER.

Specified by:

getSectionDelimiter in interface FileHeaderTransformer

Returns:

the delimiter used to separate sections in the header.

setSectionDelimiter

public void setSectionDelimiter(String sectionDelimiter)

Sets the header section delimiter. By default, will use the FileHeaderTransformer.DEFAULT_SECTION_DELIMITER.

Specified by:

setSectionDelimiter in interface FileHeaderTransformer

Parameters:

sectionDelimiter - the new delimiter

getProcessStartTag

public String getProcessStartTag()

Obtains the process tag which indicates the begin of the header content. By default, (says if you do not explicitly invoke the FileHeaderTransformer.setProcessStartTag(String) method), will use the FileHeaderTransformer.DEFAULT_PROCESS_START_TAG

Specified by:

getProcessStartTag in interface FileHeaderTransformer

Returns:

the starting header tag

setProcessStartTag

public void setProcessStartTag(String processStartTag)

Changes the process start tag.

Specified by:

setProcessStartTag in interface FileHeaderTransformer

Parameters:

processStartTag - the new start tag

getProcessEndTag

public String getProcessEndTag()

Obtain the process tag which indiciates the end of the header content. By default, (says if you do not explicitly invoke the FileHeaderTransformer.setProcessEndTag(String) method), will use the FileHeaderTransformer.DEFAULT_PROCESS_END_TAG.

Specified by:

getProcessEndTag in interface FileHeaderTransformer

Returns:

the ending header tag

setProcessEndTag

public void setProcessEndTag(String processEndTag)

Changes the process end tag.

Specified by:

setProcessEndTag in interface FileHeaderTransformer

Parameters:

processEndTag - the new endtag

getCommentStartTag

public String getCommentStartTag()

Specified by:

getCommentStartTag in interface FileHeaderTransformer

Returns:

the start tag of a comment

setCommentStartTag

public void setCommentStartTag(String commentStartTag)

Changes the comment start tag.

Specified by:

setCommentStartTag in interface FileHeaderTransformer

Parameters:

commentStartTag - the new comment start tag

getCommentEndTag

public String getCommentEndTag()

Specified by:

getCommentEndTag in interface FileHeaderTransformer

Returns:

the end tag of a comment

setCommentEndTag

public void setCommentEndTag(String commentEndTag)

Changes the comment end tag.

Specified by:

setCommentEndTag in interface FileHeaderTransformer

Parameters:

commentEndTag - the new comment end tag

getCommentLinePrefix

public String getCommentLinePrefix()

Specified by:

getCommentLinePrefix in interface FileHeaderTransformer

Returns:

the line prefix of every line insed the comment

getLineSeparator

public String getLineSeparator()

Specified by:

getLineSeparator in interface FileHeaderTransformer

setLineSeparator

public void setLineSeparator(String lineSeparator)

Specified by:

setLineSeparator in interface FileHeaderTransformer

addHeader

public String addHeader(String header,
                        String content)

Adds the header.

Specified by:

addHeader in interface FileHeaderTransformer

Parameters:

header - header to add

content - content of original file

Returns:

the new full file content beginning with header

setCommentLinePrefix

public void setCommentLinePrefix(String commentLinePrefix)

Changes the comment prefix line.

Specified by:

setCommentLinePrefix in interface FileHeaderTransformer

Parameters:

commentLinePrefix - the new comment prefix line

isEmptyLineAfterHeader

public boolean isEmptyLineAfterHeader()

Get flag if there should be an empty line after the header.

Specified by:

isEmptyLineAfterHeader in interface FileHeaderTransformer

Returns:

if there should be an empty line after the header

setEmptyLineAfterHeader

public void setEmptyLineAfterHeader(boolean emptyLine)

Set flag if there should be an empty line after the header.

Specified by:

setEmptyLineAfterHeader in interface FileHeaderTransformer

Parameters:

emptyLine - flag if there should be an empty line after the header

isTrimHeaderLine

public boolean isTrimHeaderLine()

Get flag if header line should be right trimmed when written.

Specified by:

isTrimHeaderLine in interface FileHeaderTransformer

Returns:

if header line should be right trimmed when written

setTrimHeaderLine

public void setTrimHeaderLine(boolean trimLine)

Set flag if header line should be right trimmed when written.

Specified by:

setTrimHeaderLine in interface FileHeaderTransformer

Parameters:

trimLine - flag if header line should be right trimmed when written

toFileHeader

public FileHeader toFileHeader(String header)

Build a FileHeader from an UNBOXED header content.

Specified by:

toFileHeader in interface FileHeaderTransformer

Parameters:

header - unboxed header content

Returns:

The model of the header content

toString

public String toString(FileHeader model)

Build a UNBOXED header content from the given model.

Specified by:

toString in interface FileHeaderTransformer

Parameters:

model - the model of the file header (can not be null)

Returns:

the UNBOXED header content

toHeaderContent

public String toHeaderContent(FileHeader model)

Build a fully boxed header content from the given model.

Specified by:

toHeaderContent in interface FileHeaderTransformer

Parameters:

model - the model of the file header (can not be null)

Returns:

the fully boxed header content

boxComment

public String boxComment(String header,
                         boolean withTags)

Box the given header in a comment.

Specified by:

boxComment in interface FileHeaderTransformer

Parameters:

header - the header content WITHOUT any comment boxing

withTags - flag to add start and end comment tags.

Returns:

the header content WITH comment boxing

unboxComent

public String unboxComent(String header)

Unbox the given boxed boxedHeader to obtain the header content.

Specified by:

unboxComent in interface FileHeaderTransformer

Parameters:

header - the boxed header

Returns:

the unboxed header.

boxProcessTag

public String boxProcessTag(String header)

Box the given header between process tags.

Specified by:

boxProcessTag in interface FileHeaderTransformer

Parameters:

header - the header content WITHOUT any comment boxing

Returns:

the header content boxed between process tags

See Also:

FileHeaderTransformer.getProcessStartTag(), FileHeaderTransformer.getProcessEndTag()

unboxProcessTag

public String unboxProcessTag(String boxedHeader)

Unbox the process tag on the given boxed boxedHeader to obtain the brute header content.

Specified by:

unboxProcessTag in interface FileHeaderTransformer

Parameters:

boxedHeader - the boxed header

Returns:

the brute header content.

See Also:

FileHeaderTransformer.getProcessStartTag(), FileHeaderTransformer.getProcessEndTag()

isDescriptionEquals

public boolean isDescriptionEquals(FileHeader header1,
                                   FileHeader header2)

Tests if the description of the two models are equals.

Specified by:

isDescriptionEquals in interface FileHeaderTransformer

Parameters:

header1 - the first header

header2 - the second header

Returns:

true if headers description are stricly the same

isCopyrightEquals

public boolean isCopyrightEquals(FileHeader header1,
                                 FileHeader header2)

Tests if the copyright of the two models are equals.

Specified by:

isCopyrightEquals in interface FileHeaderTransformer

Parameters:

header1 - the first header

header2 - the second header

Returns:

true if headers copyright are stricly the same

isLicenseEquals

public boolean isLicenseEquals(FileHeader header1,
                               FileHeader header2)

Tests if the license of the two models are equals.

Specified by:

isLicenseEquals in interface FileHeaderTransformer

Parameters:

header1 - the first header

header2 - the second header

Returns:

true if headers license are stricly the same (WITHOUT ANY space)