Package org.apache.maven.shared.filtering

Class AbstractMavenFilteringRequest

    • Constructor Detail

      • AbstractMavenFilteringRequest

        protected AbstractMavenFilteringRequest()
        Create instance.

      • AbstractMavenFilteringRequest

        protected AbstractMavenFilteringRequest​(org.apache.maven.project.MavenProject mavenProject,
                                        List<String> filters,
                                        org.apache.maven.execution.MavenSession mavenSession)
        Create instance with given parameters
        Parameters:
        mavenProject - The instance of MavenProject.
        filters - The list of filters.
        mavenSession - The MavenSession.

    • Method Detail

      • getMavenProject

        public org.apache.maven.project.MavenProject getMavenProject()
        Returns:
        The MavenProject

      • setMavenProject

        public void setMavenProject​(org.apache.maven.project.MavenProject mavenProject)
        Set the MavenProject.
        Parameters:
        mavenProject - The MavenProject to be set.

      • getFilters

        public List<String> getFilters()
        The list of filters.
        Returns:
        The list of currently set filters.

      • setFilters

        public void setFilters​(List<String> filters)
        Set the filters.
        Parameters:
        filters - Set the list of filters

      • setFileFilters

        public void setFileFilters​(List<String> paramfilters)
        Alias for setFilters(List)
        Parameters:
        paramfilters - The list of filters to be set.

      • isEscapeWindowsPaths

        public boolean isEscapeWindowsPaths()
        Returns:
        true if escape is activated false otherwise.
        Since:
        1.0-beta-3

      • setEscapeWindowsPaths

        public void setEscapeWindowsPaths​(boolean escapedBackslashesInFilePath)
        Parameters:
        escapedBackslashesInFilePath - true or false.
        Since:
        1.0-beta-3

      • setEscapedBackslashesInFilePath

        public void setEscapedBackslashesInFilePath​(boolean escape)
        Alias for setEscapeWindowsPaths(boolean)
        Parameters:
        escape - activate or deactivate escaping.

      • getMavenSession

        public org.apache.maven.execution.MavenSession getMavenSession()
        Returns:
        Current value of mavenSession

      • setMavenSession

        public void setMavenSession​(org.apache.maven.execution.MavenSession mavenSession)
        Parameters:
        mavenSession - Set new value for the MavenSession of the instance.

      • getAdditionalProperties

        public Properties getAdditionalProperties()
        Returns:
        the additional properties.
        Since:
        1.0-beta-3

      • setAdditionalProperties

        public void setAdditionalProperties​(Properties additionalProperties)
        Parameters:
        additionalProperties - The additional properties to be set.
        Since:
        1.0-beta-3

      • isInjectProjectBuildFilters

        public boolean isInjectProjectBuildFilters()
        Returns:
        the current value of injectProjectBuildFilters.
        Since:
        1.0-beta-3

      • setInjectProjectBuildFilters

        public void setInjectProjectBuildFilters​(boolean injectProjectBuildFilters)
        Parameters:
        injectProjectBuildFilters - true or false.
        Since:
        1.0-beta-3

      • getEscapeString

        public String getEscapeString()
        Returns:
        Current value of escapeString.
        Since:
        1.0-beta-2

      • setEscapeString

        public void setEscapeString​(String escapeString)
        Parameters:
        escapeString - The escape string to use
        Since:
        1.0-beta-2

      • getProjectStartExpressions

        public List<String> getProjectStartExpressions()
        Returns:
        The list of project start expressions.
        Since:
        1.0-beta-2

      • setProjectStartExpressions

        public void setProjectStartExpressions​(List<String> projectStartExpressions)
        Parameters:
        projectStartExpressions - The start expressions
        Since:
        1.0-beta-2

      • getDelimiters

        public LinkedHashSet<String> getDelimiters()
        See delimiters for more information and default values.
        Returns:
        Not allowed to be null or empty.
        Since:
        1.0-beta-3

      • setDelimiters

        public void setDelimiters​(LinkedHashSet<String> delimiters)
        Set the delimiter specifications to use during filtering. Specifications should be of the form: 'BEGIN*END' for asymmetrical delimiters, or 'TOKEN' for symmetrical delimiters. See delimiters for more information and default values.
        Parameters:
        delimiters - If null, reset delimiters to '${*}' only. Otherwise, use the provided value.
        Since:
        1.0-beta-3

      • setDelimiters

        public void setDelimiters​(LinkedHashSet<String> delimiters,
                          boolean useDefaultDelimiters)
        Parameters:
        delimiters - If null than nothing will happen. If not null the delimiters will be set according to the contents. If delimiter entries are null those entries will be set to '${*}'.
        useDefaultDelimiters - true if the default delimiters will be used false otherwise.

      • isSupportMultiLineFiltering

        public boolean isSupportMultiLineFiltering()
        Returns:
        If support multiple line filtering is active or not.

      • setSupportMultiLineFiltering

        public void setSupportMultiLineFiltering​(boolean supportMultiLineFiltering)
        Parameters:
        supportMultiLineFiltering - activate or deactivate multiple line filtering support.

      • getInterpolatorCustomizer

        public Consumer<org.codehaus.plexus.interpolation.Interpolator> getInterpolatorCustomizer()
        Returns:
        the customizer which is supposed to be used by filters creating an Interpolator like those based on BaseFilter.
        Since:
        3.4.0

      • setInterpolatorCustomizer

        public void setInterpolatorCustomizer​(Consumer<org.codehaus.plexus.interpolation.Interpolator> interpolatorCustomizer)
        Parameters:
        interpolatorCustomizer - the customizer which is supposed to be used by filters creating an Interpolator like those based on BaseFilter.
        Since:
        3.4.0