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
  • Constructor Details

    • FreeMarkerFileHeaderTransformer

      public FreeMarkerFileHeaderTransformer()
      Default constructor.
  • Method Details

    • 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 after the ftl directive 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:
      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
    • unboxComent

      public String unboxComent(String header)
      Reads a header written with square bracket comment delimiters.
      Specified by:
      unboxComent in interface FileHeaderTransformer
      Overrides:
      unboxComent in class AbstractFileHeaderTransformer
      Parameters:
      header - the boxed header
      Returns:
      the unboxed header.