org.apache.maven.api

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.apache.maven.api.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

@Experimental
public enum Scope
extends Enum<Scope>

Scope for a dependency

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPILE
IMPORT
PROVIDED
RUNTIME
SYSTEM
TEST

Method Summary

Modifier and Type	Method and Description
static Scope	get(String scope)
String	id()
static Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static Scope[]	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

COMPILE

public static final Scope COMPILE

PROVIDED

public static final Scope PROVIDED

SYSTEM

public static final Scope SYSTEM

RUNTIME

public static final Scope RUNTIME

TEST

public static final Scope TEST

IMPORT

public static final Scope IMPORT

Method Detail

values

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

Returns:

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

valueOf

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

id

public String id()

get

public static Scope get(String scope)