de.larssh.maven.jarrunner

Enum DependencyScope

java.lang.Object

java.lang.Enum<DependencyScope>

de.larssh.maven.jarrunner.DependencyScope

All Implemented Interfaces:

Serializable, Comparable<DependencyScope>

public enum DependencyScope
extends Enum<DependencyScope>

Dependency scope is used to limit the transitivity of a dependency, and also to affect the class path used for various build tasks.

As described at maven.apache.org.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPILE This is the default scope, used if none is specified.
IMPORT This scope is only supported on a dependency of type pom in the dependencyManagement section.
PROVIDED This is much like COMPILE, but indicates you expect the JDK or a container to provide the dependency at runtime.
RUNTIME This scope indicates that the dependency is not required for compilation, but is for execution.
SYSTEM This scope is similar to PROVIDED except that you have to provide the JAR which contains it explicitly.
TEST This scope indicates that the dependency is not required for normal use of the application, and is only available for the test compilation and execution phases.

Method Summary

Modifier and Type	Method and Description
String	getValue() Value inside POM
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

COMPILE

public static final DependencyScope COMPILE

This is the default scope, used if none is specified. Compile dependencies are available in all class paths of a project. Furthermore, those dependencies are propagated to dependent projects.

PROVIDED

public static final DependencyScope PROVIDED

This is much like COMPILE, but indicates you expect the JDK or a container to provide the dependency at runtime. For example, when building a web application for the Java Enterprise Edition, you would set the dependency on the Servlet API and related Java EE APIs to scope provided because the web container provides those classes. This scope is only available on the compilation and test class path, and is not transitive.

RUNTIME

public static final DependencyScope RUNTIME

This scope indicates that the dependency is not required for compilation, but is for execution. It is in the runtime and test class paths, but not the compile class path.

TEST

public static final DependencyScope TEST

This scope indicates that the dependency is not required for normal use of the application, and is only available for the test compilation and execution phases. This scope is not transitive.

SYSTEM

public static final DependencyScope SYSTEM

This scope is similar to PROVIDED except that you have to provide the JAR which contains it explicitly. The artifact is always available and is not looked up in a repository.

IMPORT

public static final DependencyScope IMPORT

This scope is only supported on a dependency of type pom in the dependencyManagement section. It indicates the dependency to be replaced with the effective list of dependencies in the specified POM's dependencyManagement section. Since they are replaced, dependencies with a scope of import do not actually participate in limiting the transitivity of a dependency.

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

getValue

public String getValue()

Value inside POM

Returns:

value inside POM