io.spring.initializr.generator.buildsystem

Enum DependencyScope

java.lang.Object

java.lang.Enum<DependencyScope>

io.spring.initializr.generator.buildsystem.DependencyScope

All Implemented Interfaces:

Serializable, Comparable<DependencyScope>

public enum DependencyScope
extends Enum<DependencyScope>

The scopes of dependencies supported by project generation.

Author:

Andy Wilkinson

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATION_PROCESSOR A dependency that is used as an annotation processor when compiling a project.
COMPILE A dependency that is used to compile a project.
COMPILE_ONLY A dependency that is a compile time only dependency and not used at runtime.
PROVIDED_RUNTIME A dependency that is provided and is used to run the project.
RUNTIME A dependency this is used to run a project.
TEST_COMPILE A dependency that is used to compile a project's tests.
TEST_RUNTIME A dependency this is used to run a project's tests.

Method Summary

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

ANNOTATION_PROCESSOR

public static final DependencyScope ANNOTATION_PROCESSOR

A dependency that is used as an annotation processor when compiling a project.

COMPILE

public static final DependencyScope COMPILE

A dependency that is used to compile a project.

COMPILE_ONLY

public static final DependencyScope COMPILE_ONLY

A dependency that is a compile time only dependency and not used at runtime.

RUNTIME

public static final DependencyScope RUNTIME

A dependency this is used to run a project.

PROVIDED_RUNTIME

public static final DependencyScope PROVIDED_RUNTIME

A dependency that is provided and is used to run the project.

TEST_COMPILE

public static final DependencyScope TEST_COMPILE

A dependency that is used to compile a project's tests.

TEST_RUNTIME

public static final DependencyScope TEST_RUNTIME

A dependency this is used to run a project's tests.

Method Detail

values

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

Returns:

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

valueOf

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