ShrinkWrap Resolver Maven API 2.0.0-cr-1

org.jboss.shrinkwrap.resolver.api.maven.strategy
Enum DefaultTransitiveExclusionPolicy

java.lang.Object
  extended by java.lang.Enum<DefaultTransitiveExclusionPolicy>
      extended by org.jboss.shrinkwrap.resolver.api.maven.strategy.DefaultTransitiveExclusionPolicy
All Implemented Interfaces:
Serializable, Comparable<DefaultTransitiveExclusionPolicy>, TransitiveExclusionPolicy

public enum DefaultTransitiveExclusionPolicy
extends Enum<DefaultTransitiveExclusionPolicy>
implements TransitiveExclusionPolicy

Applies the default behavior exhibited by Maven with regards to handling transitive dependencies during resolution.

Author:
Andrew Lee Rubinger
See Also:
http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Transitive_Dependencies, http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Dependency_Scope

Enum Constant Summary
INSTANCE
           
 
Method Summary
 boolean allowOptional()
          Whether or not optional transitive dependencies should be included during resolution
 ScopeType[] getFilteredScopes()
          Returns the ScopeTypes which should be filtered out of transitive dependencies and thus not included during resolution.
static DefaultTransitiveExclusionPolicy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static DefaultTransitiveExclusionPolicy[] 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 DefaultTransitiveExclusionPolicy INSTANCE
Method Detail

values

public static DefaultTransitiveExclusionPolicy[] 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 (DefaultTransitiveExclusionPolicy c : DefaultTransitiveExclusionPolicy.values())
    System.out.println(c);

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

valueOf

public static DefaultTransitiveExclusionPolicy 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

allowOptional

public boolean allowOptional()
Whether or not optional transitive dependencies should be included during resolution

Specified by:
allowOptional in interface TransitiveExclusionPolicy
Returns:
See Also:
TransitiveExclusionPolicy.allowOptional()

getFilteredScopes

public ScopeType[] getFilteredScopes()
Returns the ScopeTypes which should be filtered out of transitive dependencies and thus not included during resolution.

Specified by:
getFilteredScopes in interface TransitiveExclusionPolicy
Returns:
See Also:
TransitiveExclusionPolicy.getFilteredScopes()

ShrinkWrap Resolver Maven API 2.0.0-cr-1

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.