Package 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

@Component(role=MavenReaderFilter.class,
           hint="default")
public class DefaultMavenReaderFilter
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements MavenReaderFilter

Author:

Kristian Rosenvold

Constructor Summary

Constructors

Constructor	Description
DefaultMavenReaderFilter()

Method Summary

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

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

Constructor Detail

DefaultMavenReaderFilter

public DefaultMavenReaderFilter()

Method Detail

filter

@Nonnull
public java.io.Reader filter(@Nonnull
                             java.io.Reader from,
                             boolean filtering,
                             org.apache.maven.project.MavenProject mavenProject,
                             java.util.List<java.lang.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 filtering

mavenProject - MavenProject

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

escapedBackslashesInFilePath - escape backslashes in file path.

mavenSession - MavenSession

Returns:

an input stream that applies the filter

Throws:

MavenFilteringException - in case of failure.

See Also:

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

filter

@Nonnull
public java.io.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 - in case of failure.

filter

@Nonnull
public java.io.Reader filter(@Nonnull
                             java.io.Reader from,
                             boolean filtering,
                             @Nonnull
                             java.util.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

@Nonnull
public java.util.List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject,
                                                                                                         java.util.List<java.lang.String> filters,
                                                                                                         boolean escapedBackslashesInFilePath,
                                                                                                         org.apache.maven.execution.MavenSession mavenSession,
                                                                                                         MavenResourcesExecution mavenResourcesExecution)
                                                                                                  throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Parameters:

mavenProject - The maven project

filters - The filters to get

escapedBackslashesInFilePath - escape backslashes ?

mavenSession - The maven session

mavenResourcesExecution - The filtering configuration

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException - in case of failure.

getDefaultFilterWrappers

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

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Parameters:

req - The filtering request

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException - in case of failure.