Interface MavenReaderFilter

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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.
    • Method Detail

      • filter

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