org.eclipse.aether.util.filter

## Class PatternInclusionsDependencyFilter

- java.lang.Object
- - org.eclipse.aether.util.filter.PatternInclusionsDependencyFilter

- All Implemented Interfaces:
    DependencyFilter

      public final class PatternInclusionsDependencyFilter
      extends Object

  A simple filter to include artifacts from a list of patterns. The artifact pattern syntax is of the form:

       [groupId]:[artifactId]:[extension]:[version]

  Where each pattern segment is optional and supports full and partial `*` wildcards. An empty pattern segment is treated as an implicit wildcard. Version can be a range in case a `VersionScheme` is specified.

  For example, `org.eclipse.*` would match all artifacts whose group id started with `org.eclipse.` , and `:::*-SNAPSHOT` would match all snapshot artifacts.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `PatternInclusionsDependencyFilter(Collection<String> patterns)` Creates a new filter using the specified patterns.
    `PatternInclusionsDependencyFilter(String... patterns)` Creates a new filter using the specified patterns.
    `PatternInclusionsDependencyFilter(VersionScheme versionScheme, Collection<String> patterns)` Creates a new filter using the specified patterns and `VersionScheme` .
    `PatternInclusionsDependencyFilter(VersionScheme versionScheme, String... patterns)` Creates a new filter using the specified patterns.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | `accept(Artifact artifact)`
    `boolean` | `accept(DependencyNode node, List<DependencyNode> parents)` Indicates whether the specified dependency node shall be included or excluded.
    `boolean` | `equals(Object obj)`
    `int` | `hashCode()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### PatternInclusionsDependencyFilter

          public PatternInclusionsDependencyFilter(String... patterns)

      Creates a new filter using the specified patterns.
      Parameters:
        `patterns` - The include patterns, may be `null` or empty to include no artifacts.

    - #### PatternInclusionsDependencyFilter

          public PatternInclusionsDependencyFilter(VersionScheme versionScheme,
                                           String... patterns)

      Creates a new filter using the specified patterns.
      Parameters:
        `versionScheme` - To be used for parsing versions/version ranges. If `null` and pattern specifies a range no artifact will be included.
        `patterns` - The include patterns, may be `null` or empty to include no artifacts.

    - #### PatternInclusionsDependencyFilter

          public PatternInclusionsDependencyFilter(Collection<String> patterns)

      Creates a new filter using the specified patterns.
      Parameters:
        `patterns` - The include patterns, may be `null` or empty to include no artifacts.

    - #### PatternInclusionsDependencyFilter

          public PatternInclusionsDependencyFilter(VersionScheme versionScheme,
                                           Collection<String> patterns)

      Creates a new filter using the specified patterns and `VersionScheme` .
      Parameters:
        `versionScheme` - To be used for parsing versions/version ranges. If `null` and pattern specifies a range no artifact will be included.
        `patterns` - The include patterns, may be `null` or empty to include no artifacts.

  - ### Method Detail

    - #### accept

          public boolean accept(DependencyNode node,
                       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.

    - #### accept

          protected boolean accept(Artifact artifact)

    - #### equals

          public boolean equals(Object obj)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

Copyright © 2010-2012 The Eclipse Foundation. All Rights Reserved.