org.codehaus.mojo.license.header.transformer

Class JavaFileHeaderTransformer

java.lang.Object

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

org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

All Implemented Interfaces:

FileHeaderTransformer

@Component(role=FileHeaderTransformer.class,
           hint="java")
public class JavaFileHeaderTransformer
extends AbstractFileHeaderTransformer

Implementation of FileHeaderTransformer for java format.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addJavaLicenseAfterPackage Flag to add the license header after the package statement.
protected boolean	useNoReformatCommentStartTag Flag to use comment start tag with a no reformat syntax /*-.

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

Constructor and Description
JavaFileHeaderTransformer() Default constructor.

Method Summary

Modifier and Type	Method and Description
String	addHeader(String header, String content) Adds the header.
String	getCommentStartTag()
String[]	getDefaultAcceptedExtensions() Get the default accepted extensions for this transformer.
void	setAddJavaLicenseAfterPackage(boolean addJavaLicenseAfterPackage) Sets the value to the property addJavaLicenseAfterPackage.
void	setUseNoReformatCommentStartTag(boolean useNoReformatCommentStartTag) Sets the value of the property useNoReformatCommentStartTag.

Methods inherited from class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

boxComment, boxProcessTag, getCommentEndTag, getCommentLinePrefix, getDescription, getLineSeparator, getName, getProcessEndTag, getProcessStartTag, getSectionDelimiter, isCopyrightEquals, isDescriptionEquals, isEmptyLineAfterHeader, isLicenseEquals, isTrimHeaderLine, setCommentEndTag, setCommentLinePrefix, setCommentStartTag, setDescription, setEmptyLineAfterHeader, setLineSeparator, setName, setProcessEndTag, setProcessStartTag, setSectionDelimiter, setTrimHeaderLine, toFileHeader, toHeaderContent, toString, unboxComent, unboxProcessTag

Methods inherited from class java.lang.Object

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

Field Detail

addJavaLicenseAfterPackage

protected boolean addJavaLicenseAfterPackage

Flag to add the license header after the package statement.

Since:

1.2

useNoReformatCommentStartTag

protected boolean useNoReformatCommentStartTag

Flag to use comment start tag with a no reformat syntax /*-. See http://www.oracle.com/technetwork/java/javase/documentation/codeconventions-141999.html#350

Since:

1.9

Constructor Detail

JavaFileHeaderTransformer

public JavaFileHeaderTransformer()

Default constructor.

Method Detail

getDefaultAcceptedExtensions

public String[] getDefaultAcceptedExtensions()

Get the default accepted extensions for this transformer.

Returns:

the default accepted extensions.

setAddJavaLicenseAfterPackage

public void setAddJavaLicenseAfterPackage(boolean addJavaLicenseAfterPackage)

Sets the value to the property addJavaLicenseAfterPackage.

Parameters:

addJavaLicenseAfterPackage - the new value to set

Since:

1.2

setUseNoReformatCommentStartTag

public void setUseNoReformatCommentStartTag(boolean useNoReformatCommentStartTag)

Sets the value of the property useNoReformatCommentStartTag.

Parameters:

useNoReformatCommentStartTag - the new value to set

Since:

1.9

getCommentStartTag

public String getCommentStartTag()

Description copied from class: AbstractFileHeaderTransformer

Specified by:

getCommentStartTag in interface FileHeaderTransformer

Overrides:

getCommentStartTag in class AbstractFileHeaderTransformer

Returns:

the start tag of a comment

addHeader

public String addHeader(String header,
                        String content)

Adds the header.

Specified by:

addHeader in interface FileHeaderTransformer

Overrides:

addHeader in class AbstractFileHeaderTransformer

Parameters:

header - header to add

content - content of original file

Returns:

the new full file content beginning with header