Package org.openrewrite.maven.tree

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.openrewrite.maven.tree.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Scope>

public enum Scope
extends java.lang.Enum<Scope>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Compile
None
Provided
Runtime
System
Test

Method Summary

Modifier and Type	Method	Description
static Scope	fromName(java.lang.String scope)
boolean	isInClasspathOf(Scope scope)
Scope	transitiveOf(Scope scope)	See the table at https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#dependency-scope.
static Scope	valueOf(java.lang.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

None

public static final Scope None

Compile

public static final Scope Compile

Provided

public static final Scope Provided

Runtime

public static final Scope Runtime

Test

public static final Scope Test

System

public static final Scope System

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isInClasspathOf

public boolean isInClasspathOf(@Nullable
                               Scope scope)

Parameters:

scope - The scope to test

Returns:

If a dependency in this scope would be in the classpath of the tested scope.

transitiveOf

@Nullable
public Scope transitiveOf(@Nullable
                          Scope scope)

See the table at https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#dependency-scope. this represents the scope on the top row of the table.

Parameters:

scope - The scope on the left column of the table.

Returns:

The scope inside the table.

fromName

public static Scope fromName(@Nullable
                             java.lang.String scope)