org.apache.maven.shared.filtering
Class DefaultMavenReaderFilter

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.shared.filtering.DefaultMavenReaderFilter

All Implemented Interfaces:

DefaultFilterInfo, MavenReaderFilter, org.codehaus.plexus.logging.LogEnabled

public class DefaultMavenReaderFilter
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements MavenReaderFilter

Author:

Kristian Rosenvold

Plexus component:

role: "org.apache.maven.shared.filtering.MavenReaderFilter" role-hint: "default"

DefaultMavenReaderFilter

public DefaultMavenReaderFilter()

filter

@Nonnull
public Reader filter(@Nonnull
                             Reader from,
                             boolean filtering,
                             MavenProject mavenProject,
                             List<String> filters,
                             boolean escapedBackslashesInFilePath,
                             MavenSession mavenSession)
              throws MavenFilteringException

Description copied from interface: MavenReaderFilter

Provides a new reader that applies filtering using defaultFilterWrappers.

Specified by:

filter in interface MavenReaderFilter

Parameters:

from - the source reader

filtering - enable or not filering

mavenProject - the mavenproject

filters - List of String which are path to a Property file

Returns:

an input stream that applies the filter

Throws:

MavenFilteringException

See Also:

DefaultFilterInfo.getDefaultFilterWrappers(org.apache.maven.project.MavenProject, java.util.List, boolean, org.apache.maven.execution.MavenSession)

filter

@Nonnull
public Reader filter(@Nonnull
                             MavenReaderFilterRequest mavenFileFilterRequest)
              throws MavenFilteringException

Description copied from interface: MavenReaderFilter

Provides a new reader that applies filtering using defaultFilterWrappers.

Specified by:

filter in interface MavenReaderFilter

Parameters:

mavenFileFilterRequest - The filter request

Returns:

an input stream that applies the filter

Throws:

MavenFilteringException

filter

@Nonnull
public Reader filter(@Nonnull
                             Reader from,
                             boolean filtering,
                             @Nonnull
                             List<FileUtils.FilterWrapper> filterWrappers)

Description copied from interface: MavenReaderFilter

Provides a new reader that applies filtering using defaultFilterWrappers.

Specified by:

filter in interface MavenReaderFilter

Parameters:

from - the source reader

filtering - true to apply filtering

filterWrappers - List of FileUtils.FilterWrapper

Returns:

an input stream that applies the filter

getDefaultFilterWrappers

public List<FileUtils.FilterWrapper> getDefaultFilterWrappers(MavenProject mavenProject,
                                                              List<String> filters,
                                                              boolean escapedBackslashesInFilePath,
                                                              MavenSession mavenSession)
                                                       throws MavenFilteringException

Deprecated. 

Description copied from interface: DefaultFilterInfo

Will return the default FileUtils.FilterWrappers.

• interpolate with token ${} and values from sysProps, project.properties, filters and project filters.
• interpolate with token @ @ and values from sysProps, project.properties, filters and project filters.
• interpolate with token ${} and values from mavenProject interpolation.
• interpolation with token @ @ and values from mavenProject interpolation

This method is now deprecated and no escape mechanism will be used.

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

filters - List of properties file

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

See Also:

DefaultFilterInfo.getDefaultFilterWrappers(org.apache.maven.project.MavenProject, java.util.List, boolean, org.apache.maven.execution.MavenSession)

getDefaultFilterWrappers

@Nonnull
public List<FileUtils.FilterWrapper> getDefaultFilterWrappers(MavenProject mavenProject,
                                                                      List<String> filters,
                                                                      boolean escapedBackslashesInFilePath,
                                                                      MavenSession mavenSession,
                                                                      MavenResourcesExecution mavenResourcesExecution)
                                                       throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

getDefaultFilterWrappers

@Nonnull
public List<FileUtils.FilterWrapper> getDefaultFilterWrappers(AbstractMavenFilteringRequest req)
                                                       throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException