Package io.github.cdklabs.projen

Enum DependencyType

java.lang.Object

java.lang.Enum<DependencyType>

io.github.cdklabs.projen.DependencyType

All Implemented Interfaces:

Serializable, Comparable<DependencyType>

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.736Z")
@Stability(Experimental)
public enum DependencyType
extends Enum<DependencyType>

(experimental) Type of dependency.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUILD	(experimental) The dependency is required to run the build task.
BUNDLED	(experimental) The dependency is bundled and shipped with the module, so consumers are not required to install it.
DEVENV	(experimental) The dependency is required for development (e.g.
OPTIONAL	(experimental) An optional dependency that may be used at runtime if available, but is not required.
OVERRIDE	(experimental) Transient dependency that needs to be overwritten.
PEER	(experimental) The dependency is required at runtime but expected to be installed by the consumer.
RUNTIME	(experimental) The dependency is required for the program/library during runtime.
TEST	(experimental) The dependency is required to run the test task.

Method Summary

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

RUNTIME

@Stability(Experimental)
public static final DependencyType RUNTIME

(experimental) The dependency is required for the program/library during runtime.

PEER

@Stability(Experimental)
public static final DependencyType PEER

(experimental) The dependency is required at runtime but expected to be installed by the consumer.

BUNDLED

@Stability(Experimental)
public static final DependencyType BUNDLED

(experimental) The dependency is bundled and shipped with the module, so consumers are not required to install it.

BUILD

@Stability(Experimental)
public static final DependencyType BUILD

(experimental) The dependency is required to run the build task.

TEST

@Stability(Experimental)
public static final DependencyType TEST

(experimental) The dependency is required to run the test task.

DEVENV

@Stability(Experimental)
public static final DependencyType DEVENV

(experimental) The dependency is required for development (e.g. IDE plugins).

OVERRIDE

@Stability(Experimental)
public static final DependencyType OVERRIDE

(experimental) Transient dependency that needs to be overwritten.

Available for Node packages

OPTIONAL

@Stability(Experimental)
public static final DependencyType OPTIONAL

(experimental) An optional dependency that may be used at runtime if available, but is not required.

It is expected to be installed by the consumer.

Method Detail

values

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

Returns:

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

valueOf

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