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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addJavaLicenseAfterPackage Flag to add the license header after the package statement.

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

commentEndTag, commentLinePrefix, commentStartTag, COPYRIGHT_PATTERN, description, name, processEndTag, processStartTag, REMOVE_SPACE_PATTERN, sectionDelimiter

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

DEFAULT_PROCESS_END_TAG, DEFAULT_PROCESS_START_TAG, DEFAULT_SECTION_DELIMITER, LINE_SEPARATOR, ROLE_NAME

Constructor Summary

Constructors

Constructor and Description
JavaFileHeaderTransformer() Default constructor.

Method Summary

Methods

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

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

boxComment, boxProcessTag, getCommentEndTag, getCommentLinePrefix, getCommentStartTag, getDescription, getName, getProcessEndTag, getProcessStartTag, getSectionDelimiter, isCopyrightEquals, isDescriptionEquals, isLicenseEquals, removeSpaces, setCommentEndTag, setCommentLinePrefix, setCommentStartTag, setDescription, setName, setProcessEndTag, setProcessStartTag, setSectionDelimiter, 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

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

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