org.apache.maven.shared.filtering

Interface MavenReaderFilter

All Superinterfaces:

DefaultFilterInfo

All Known Implementing Classes:

DefaultMavenReaderFilter

public interface MavenReaderFilter
extends DefaultFilterInfo

Since:

1.3

Author:

Olivier Lamy, Kristian Rosenvold

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.

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

getDefaultFilterWrappers, getDefaultFilterWrappers

Method Detail

filter

@Nonnull
Reader filter(@Nonnull
                       Reader from,
                       boolean filtering,
                       @Nullable
                       org.apache.maven.project.MavenProject mavenProject,
                       List<String> filters,
                       boolean escapedBackslashesInFilePath,
                       org.apache.maven.execution.MavenSession mavenSession)
                throws MavenFilteringException

Provides a new reader that applies filtering using defaultFilterWrappers.

Parameters:

from - the source reader

filtering - enable or not filtering

mavenProject - MavenProject

mavenSession - MavenSession

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

escapedBackslashesInFilePath - escape backslashes in file path.

Returns:

an input stream that applies the filter

Throws:

MavenFilteringException - in case of failure.

See Also:

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

filter

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

Provides a new reader that applies filtering using defaultFilterWrappers.

Parameters:

mavenFileFilterRequest - The filter request

Returns:

an input stream that applies the filter

Throws:

MavenFilteringException - in case of failure.

Since:

1.0-beta-3

filter

@Nonnull
Reader filter(@Nonnull
                       Reader from,
                       boolean filtering,
                       @Nonnull
                       List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers)

Provides a new reader that applies filtering using defaultFilterWrappers.

Parameters:

from - the source reader

filtering - true to apply filtering

filterWrappers - List of FileUtils.FilterWrapper

Returns:

an input stream that applies the filter