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

filter

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

Provides a new reader that applies filtering using defaultFilterWrappers.

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
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

Since:

1.0-beta-3

filter

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