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

Constructor Summary

Constructors

Constructor and Description
DefaultMavenReaderFilter()

Method Summary

Modifier and Type	Method and Description
Reader	filter(MavenReaderFilterRequest mavenFileFilterRequest) Provides a new reader that applies filtering using defaultFilterWrappers.
Reader	filter(Reader from, boolean filtering, List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers) Provides a new reader that applies filtering using defaultFilterWrappers.
Reader	filter(Reader from, boolean filtering, org.apache.maven.project.MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, org.apache.maven.execution.MavenSession mavenSession) Provides a new reader that applies filtering using defaultFilterWrappers.
List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper>	getDefaultFilterWrappers(AbstractMavenFilteringRequest req)
List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper>	getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, org.apache.maven.execution.MavenSession mavenSession) Deprecated.
List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper>	getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, org.apache.maven.execution.MavenSession mavenSession, MavenResourcesExecution mavenResourcesExecution)

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

Methods inherited from interface org.apache.maven.shared.filtering.DefaultFilterInfo

getDefaultFilterWrappers, getDefaultFilterWrappers, getDefaultFilterWrappers

Constructor Detail

DefaultMavenReaderFilter

public DefaultMavenReaderFilter()

Method Detail

filter

@Nonnull
public Reader filter(@Nonnull
                              Reader from,
                              boolean filtering,
                              org.apache.maven.project.MavenProject mavenProject,
                              List<String> filters,
                              boolean escapedBackslashesInFilePath,
                              org.apache.maven.execution.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<org.apache.maven.shared.utils.io.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<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject,
                                                                                               List<String> filters,
                                                                                               boolean escapedBackslashesInFilePath,
                                                                                               org.apache.maven.execution.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<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject,
                                                                                                        List<String> filters,
                                                                                                        boolean escapedBackslashesInFilePath,
                                                                                                        org.apache.maven.execution.MavenSession mavenSession,
                                                                                                        MavenResourcesExecution mavenResourcesExecution)
                                                                                                 throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

getDefaultFilterWrappers

@Nonnull
public List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> getDefaultFilterWrappers(AbstractMavenFilteringRequest req)
                                                                                                 throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException