Package org.eclipse.aether.util.filter

Class ScopeDependencyFilter

  • All Implemented Interfaces:
    DependencyFilter
    public final class ScopeDependencyFilter
extends java.lang.Object
implements DependencyFilter
    A dependency filter based on dependency scopes. Note: This filter does not assume any relationships between the scopes. In particular, the filter is not aware of scopes that logically include other scopes.
    See Also:
    Dependency.getScope()

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Set<java.lang.String> excluded  
      private java.util.Set<java.lang.String> included  

    • Constructor Summary

      Constructors 
      Constructor Description
      ScopeDependencyFilter​(java.lang.String... excluded)
      Creates a new filter using the specified excludes.
      ScopeDependencyFilter​(java.util.Collection<java.lang.String> included, java.util.Collection<java.lang.String> excluded)
      Creates a new filter using the specified includes and excludes.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accept​(DependencyNode node, java.util.List<DependencyNode> parents)
      Indicates whether the specified dependency node shall be included or excluded.
      boolean equals​(java.lang.Object obj)  
      int hashCode()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • included

        private final java.util.Set<java.lang.String> included

      • excluded

        private final java.util.Set<java.lang.String> excluded

    • Constructor Detail

      • ScopeDependencyFilter

        public ScopeDependencyFilter​(java.util.Collection<java.lang.String> included,
                             java.util.Collection<java.lang.String> excluded)
        Creates a new filter using the specified includes and excludes.
        Parameters:
        included - The set of scopes to include, may be null or empty to include any scope.
        excluded - The set of scopes to exclude, may be null or empty to exclude no scope.

      • ScopeDependencyFilter

        public ScopeDependencyFilter​(java.lang.String... excluded)
        Creates a new filter using the specified excludes.
        Parameters:
        excluded - The set of scopes to exclude, may be null or empty to exclude no scope.

    • Method Detail

      • accept

        public boolean accept​(DependencyNode node,
                      java.util.List<DependencyNode> parents)
        Description copied from interface: DependencyFilter
        Indicates whether the specified dependency node shall be included or excluded.
        Specified by:
        accept in interface DependencyFilter
        Parameters:
        node - The dependency node to filter, must not be null.
        parents - The (read-only) chain of parent nodes that leads to the node to be filtered, must not be null. Iterating this (possibly empty) list walks up the dependency graph towards the root node, i.e. the immediate parent node (if any) is the first node in the list. The size of the list also denotes the zero-based depth of the filtered node.
        Returns:
        true to include the dependency node, false to exclude it.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object