Package org.apache.maven.api

Enum ResolutionScope

java.lang.Object

java.lang.Enum<ResolutionScope>

org.apache.maven.api.ResolutionScope

All Implemented Interfaces:

Serializable, Comparable<ResolutionScope>, java.lang.constant.Constable

@Experimental
public enum ResolutionScope
extends Enum<ResolutionScope>

Dependencies resolution scopes available before mojo execution. Important note: The id values of this enum correspond to constants of org.apache.maven.artifact.Artifact class and MUST BE KEPT IN SYNC.

Since:

4.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPILE	compile resolution scope = compile + system + provided dependencies
COMPILE_PLUS_RUNTIME	compile+runtime resolution scope (Maven 3 only) = compile + system + provided + runtime dependencies
NONE	empty resolution scope
RUNTIME	runtime resolution scope = compile + runtime dependencies
RUNTIME_PLUS_SYSTEM	runtime+system resolution scope (Maven 3 only) = compile + system + runtime dependencies
TEST	test resolution scope = compile + system + provided + runtime + test dependencies

Method Summary

Modifier and Type	Method	Description
static ResolutionScope	fromString(String id)
String	id()
Set<Scope>	scopes()
static ResolutionScope	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ResolutionScope[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ResolutionScope NONE

empty resolution scope

COMPILE

public static final ResolutionScope COMPILE

compile resolution scope = compile + system + provided dependencies

COMPILE_PLUS_RUNTIME

public static final ResolutionScope COMPILE_PLUS_RUNTIME

compile+runtime resolution scope (Maven 3 only) = compile + system + provided + runtime dependencies

RUNTIME

public static final ResolutionScope RUNTIME

runtime resolution scope = compile + runtime dependencies

RUNTIME_PLUS_SYSTEM

public static final ResolutionScope RUNTIME_PLUS_SYSTEM

runtime+system resolution scope (Maven 3 only) = compile + system + runtime dependencies

TEST

public static final ResolutionScope TEST

test resolution scope = compile + system + provided + runtime + test dependencies

Method Details

values

public static ResolutionScope[] values()

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

Returns:

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

valueOf

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

fromString

public static ResolutionScope fromString(String id)

id

public String id()

scopes

public Set<Scope> scopes()