Class ScopeArtifactFilter

  • All Implemented Interfaces:
    org.apache.maven.artifact.resolver.filter.ArtifactFilter, StatisticsReportingArtifactFilter

    public class ScopeArtifactFilter
    extends java.lang.Object
    implements org.apache.maven.artifact.resolver.filter.ArtifactFilter, StatisticsReportingArtifactFilter

    ArtifactFilter implementation that selects artifacts based on their scopes.

    NOTE: None of the fine-grained scopes imply other scopes when enabled; when fine-grained scope control is used, each scope must be enabled separately, UNLESS the corresponding XXXWithImplications() method is used to enable that scope.
    • Field Detail

      • includeCompileScope

        private boolean includeCompileScope
      • includeRuntimeScope

        private boolean includeRuntimeScope
      • includeTestScope

        private boolean includeTestScope
      • includeProvidedScope

        private boolean includeProvidedScope
      • includeSystemScope

        private boolean includeSystemScope
      • includeNullScope

        private boolean includeNullScope
      • nullScopeHit

        private boolean nullScopeHit
      • compileScopeHit

        private boolean compileScopeHit
      • runtimeScopeHit

        private boolean runtimeScopeHit
      • testScopeHit

        private boolean testScopeHit
      • providedScopeHit

        private boolean providedScopeHit
      • systemScopeHit

        private boolean systemScopeHit
      • filteredArtifactIds

        private java.util.List<java.lang.String> filteredArtifactIds
    • Constructor Detail

      • ScopeArtifactFilter

        public ScopeArtifactFilter()
        Constructor that is meant to be used with fine-grained manipulation to enable/disable specific scopes using the associated mutator methods.
      • ScopeArtifactFilter

        public ScopeArtifactFilter​(java.lang.String scope)
        Constructor that uses the implied nature of Maven scopes to determine which artifacts to include. For instance, 'test' scope implies compile, provided, and runtime, while 'runtime' scope implies only compile.
        Parameters:
        scope - the scope
    • Method Detail

      • include

        public boolean include​(org.apache.maven.artifact.Artifact artifact)
        Specified by:
        include in interface org.apache.maven.artifact.resolver.filter.ArtifactFilter
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        Information converted to a string.
      • isIncludeTestScope

        public boolean isIncludeTestScope()
        Returns:
        includeTestScope
      • isIncludeSystemScope

        public boolean isIncludeSystemScope()
        Returns:
        includeSystemScope
      • setIncludeSystemScope

        public ScopeArtifactFilter setIncludeSystemScope​(boolean pIncludeSystemScope)
      • setIncludeCompileScopeWithImplications

        public ScopeArtifactFilter setIncludeCompileScopeWithImplications​(boolean enabled)
        Manages the following scopes:
        • system
        • provided
        • compile
        Parameters:
        enabled - whether specified scopes should be included
        Returns:
        this instance
      • setIncludeRuntimeScopeWithImplications

        public ScopeArtifactFilter setIncludeRuntimeScopeWithImplications​(boolean enabled)
        Manages the following scopes:
        • compile
        • runtime
        Parameters:
        enabled - whether specified scopes should be included
        Returns:
        this instance
      • setIncludeTestScopeWithImplications

        public ScopeArtifactFilter setIncludeTestScopeWithImplications​(boolean enabled)
        Manages the following scopes:
        • system
        • provided
        • compile
        • runtime
        • test
        Parameters:
        enabled - whether specified scopes should be included
        Returns:
        this instance
      • setIncludeNullScope

        public ScopeArtifactFilter setIncludeNullScope​(boolean enable)
        Determine whether artifacts that have a null scope are included or excluded.
        Parameters:
        enable - whether null-scope should be included
        Returns:
        this instance
      • reset

        public ScopeArtifactFilter reset()
        Reset hit counts and tracking of filtered artifacts, BUT NOT ENABLED SCOPES.
        Returns:
        this instance