org.owasp.maven.tools

Class VelocityWhitespaceFilter

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.shared.filtering.DefaultMavenFileFilter

org.owasp.maven.tools.VelocityWhitespaceFilter

All Implemented Interfaces:

org.apache.maven.shared.filtering.DefaultFilterInfo, org.apache.maven.shared.filtering.MavenFileFilter, org.codehaus.plexus.logging.LogEnabled

@Component(role=org.apache.maven.shared.filtering.MavenFileFilter.class,
           hint="default")
public class VelocityWhitespaceFilter
extends org.apache.maven.shared.filtering.DefaultMavenFileFilter

Simple resource filter that is used to remove excess whitespace from Velocity Templates using standard Maven resource filtering. Leading whitespace is removed from lines and a trailing Velocity comment (##) is appended to each line to swallow the new line from the resulting output.

Author:

Jeremy Long

Constructor Summary

Constructors

Constructor and Description
VelocityWhitespaceFilter()

Method Summary

Modifier and Type	Method and Description
void	copyFile(File from, File to, boolean filtering, List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers, String encoding, boolean overwrite) Copies the given file using the VelocityWhitespaceFilteringReader so that the Velocity Template copied will output less whitespace.
protected boolean	shouldFilter(File from) Whether or not the given file should be filtered.

Methods inherited from class org.apache.maven.shared.filtering.DefaultMavenFileFilter

copyFile, copyFile, copyFile

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityWhitespaceFilter

public VelocityWhitespaceFilter()

Method Detail

shouldFilter

protected boolean shouldFilter(File from)

Whether or not the given file should be filtered.

Parameters:

from - the file to test

Returns:

true if this filter should transform the file, otherwise false

copyFile

public void copyFile(File from,
                     File to,
                     boolean filtering,
                     List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers,
                     String encoding,
                     boolean overwrite)
              throws org.apache.maven.shared.filtering.MavenFilteringException

Copies the given file using the VelocityWhitespaceFilteringReader so that the Velocity Template copied will output less whitespace.

Specified by:

copyFile in interface org.apache.maven.shared.filtering.MavenFileFilter

Overrides:

copyFile in class org.apache.maven.shared.filtering.DefaultMavenFileFilter

Throws:

org.apache.maven.shared.filtering.MavenFilteringException