org.jboss.shrinkwrap.resolver.api.maven.filter

Enum NonTransitiveFilter

java.lang.Object

java.lang.Enum<NonTransitiveFilter>

org.jboss.shrinkwrap.resolver.api.maven.filter.NonTransitiveFilter

All Implemented Interfaces:

Serializable, Comparable<NonTransitiveFilter>, MavenResolutionFilter, ResolutionFilter

public enum NonTransitiveFilter
extends Enum<NonTransitiveFilter>
implements MavenResolutionFilter

A filter which does not allow transitive dependencies, allowing only what's explicitly defined.

Author:

Karel Piwko, Andrew Lee Rubinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	accepts(MavenDependency dependency, List<MavenDependency> dependenciesForResolution, List<MavenDependency> dependencyAncestors) Determines whether or not a MavenDependency is accepted by this filter.
static NonTransitiveFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static NonTransitiveFilter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final NonTransitiveFilter INSTANCE

Method Detail

values

public static NonTransitiveFilter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NonTransitiveFilter c : NonTransitiveFilter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NonTransitiveFilter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

accepts

public boolean accepts(MavenDependency dependency,
                       List<MavenDependency> dependenciesForResolution,
                       List<MavenDependency> dependencyAncestors)

Determines whether or not a MavenDependency is accepted by this filter. The filtering mechanism may consult the project's explicitly-defined dependencies and dependencyManagement (guaranteed immutable and non-null) in determining whether filtering should be applied.

Specified by:

accepts in interface MavenResolutionFilter

Parameters:

dependency - Candidate for inclusion

dependenciesForResolution - Explicitly-declared dependencies for the current session, does not include those obtained via transitivity

dependencyAncestors - A list of ancestors of the candidate for inclusion.

Returns:

Whether or not a MavenDependency is accepted by this filter.

See Also:

MavenResolutionFilter.accepts(org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependency, java.util.List, java.util.List)