org.codehaus.mojo.license.header.transformer

Class PropertiesFileHeaderTransformer

java.lang.Object

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

org.codehaus.mojo.license.header.transformer.PropertiesFileHeaderTransformer

All Implemented Interfaces:

FileHeaderTransformer

@Component(role=FileHeaderTransformer.class,
           hint="properties")
public class PropertiesFileHeaderTransformer
extends AbstractFileHeaderTransformer

Implementation of FileHeaderTransformer for properties format.

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

Constructor and Description
PropertiesFileHeaderTransformer() Default constructor.

Method Summary

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.

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

boxComment, boxProcessTag, getCommentEndTag, getCommentLinePrefix, getCommentStartTag, 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

Constructor Detail

PropertiesFileHeaderTransformer

public PropertiesFileHeaderTransformer()

Default constructor.

Method Detail

getDefaultAcceptedExtensions

public String[] getDefaultAcceptedExtensions()

Get the default accepted extensions for this transformer.

Returns:

the default accepted extensions.

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