Class FreeMarkerFileHeaderTransformer
java.lang.Object
org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer
org.codehaus.mojo.license.header.transformer.FreeMarkerFileHeaderTransformer
- All Implemented Interfaces:
FileHeaderTransformer
@Named("ftl")
@Singleton
public class FreeMarkerFileHeaderTransformer
extends AbstractFileHeaderTransformer
Implementation of
FileHeaderTransformer for freemarker format.- Since:
- 1.0
- Author:
- tchemit dev@tchemit.fr
-
Field Summary
Fields inherited from interface FileHeaderTransformer
DEFAULT_PROCESS_END_TAG, DEFAULT_PROCESS_START_TAG, DEFAULT_SECTION_DELIMITER, LINE_SEPARATOR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdds the header after theftldirective when the template starts with one, as FreeMarker does not accept anything before it.String[]Get the default accepted extensions for this transformer.unboxComent(String header) Reads a header written with square bracket comment delimiters.Methods inherited from class 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, unboxProcessTag
-
Constructor Details
-
FreeMarkerFileHeaderTransformer
public FreeMarkerFileHeaderTransformer()Default constructor.
-
-
Method Details
-
getDefaultAcceptedExtensions
Get the default accepted extensions for this transformer.- Returns:
- the default accepted extensions.
-
addHeader
Adds the header after theftldirective when the template starts with one, as FreeMarker does not accept anything before it. In a template using the square bracket syntax the header is written with square bracket comment delimiters.- Specified by:
addHeaderin interfaceFileHeaderTransformer- Overrides:
addHeaderin classAbstractFileHeaderTransformer- Parameters:
header- header to addcontent- content of original file- Returns:
- the new full file content beginning with header
-
unboxComent
Reads a header written with square bracket comment delimiters.- Specified by:
unboxComentin interfaceFileHeaderTransformer- Overrides:
unboxComentin classAbstractFileHeaderTransformer- Parameters:
header- the boxed header- Returns:
- the unboxed header.
-