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
PROJECT_COMPILE	compile resolution scope = compile-only + compile + provided dependencies
PROJECT_RUNTIME	runtime resolution scope = compile + runtime dependencies
TEST_COMPILE	test-compile resolution scope = compile-only + compile + provided + test-compile-only + test dependencies
TEST_RUNTIME	test resolution scope = compile + runtime + provided + test + test-runtime 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

PROJECT_COMPILE

public static final ResolutionScope PROJECT_COMPILE

compile resolution scope = compile-only + compile + provided dependencies

PROJECT_RUNTIME

public static final ResolutionScope PROJECT_RUNTIME

runtime resolution scope = compile + runtime dependencies

TEST_COMPILE

public static final ResolutionScope TEST_COMPILE

test-compile resolution scope = compile-only + compile + provided + test-compile-only + test dependencies

TEST_RUNTIME

public static final ResolutionScope TEST_RUNTIME

test resolution scope = compile + runtime + provided + test + test-runtime 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()