Package org.apache.maven.shared.filtering

Class DefaultMavenReaderFilter

java.lang.Object

org.apache.maven.shared.filtering.DefaultMavenReaderFilter

All Implemented Interfaces:

DefaultFilterInfo, MavenReaderFilter

@Singleton
@Named
public class DefaultMavenReaderFilter
extends Object
implements MavenReaderFilter

Author:

Kristian Rosenvold

Constructor Summary

Constructors

Constructor	Description
DefaultMavenReaderFilter()

Method Summary

Modifier and Type	Method	Description
Reader	filter(Reader from, boolean filtering, List<FilterWrapper> filterWrappers)	Provides a new reader that applies filtering using defaultFilterWrappers.
Reader	filter(Reader from, boolean filtering, org.apache.maven.api.Project mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, org.apache.maven.api.Session mavenSession)	Provides a new reader that applies filtering using defaultFilterWrappers.
Reader	filter(MavenReaderFilterRequest mavenFileFilterRequest)	Provides a new reader that applies filtering using defaultFilterWrappers.
List<FilterWrapper>	getDefaultFilterWrappers(org.apache.maven.api.Project mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, org.apache.maven.api.Session mavenSession, MavenResourcesExecution mavenResourcesExecution)
List<FilterWrapper>	getDefaultFilterWrappers(AbstractMavenFilteringRequest request)
protected org.slf4j.Logger	getLogger()

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 Details

DefaultMavenReaderFilter

public DefaultMavenReaderFilter()

Method Details

filter

public Reader filter(Reader from,
 boolean filtering,
 org.apache.maven.api.Project mavenProject,
 List<String> filters,
 boolean escapedBackslashesInFilePath,
 org.apache.maven.api.Session 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 - Project

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

escapedBackslashesInFilePath - escape backslashes in file path.

mavenSession - Session

Returns:

an input stream that applies the filter

Throws:

MavenFilteringException - in case of failure.

filter

public Reader filter(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

public Reader filter(Reader from,
 boolean filtering,
 List<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

getLogger

protected org.slf4j.Logger getLogger()

getDefaultFilterWrappers

public List<FilterWrapper> getDefaultFilterWrappers(org.apache.maven.api.Project mavenProject,
 List<String> filters,
 boolean escapedBackslashesInFilePath,
 org.apache.maven.api.Session 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

public List<FilterWrapper> getDefaultFilterWrappers(AbstractMavenFilteringRequest request)
                                             throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Parameters:

request - The filtering request

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException - in case of failure.