ConfigurationName (plugin-base 1.8.2 API)

java.lang.Object
- java.lang.Enum<ConfigurationName>
- - io.spine.tools.gradle.ConfigurationName

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConfigurationName>
```
public enum ConfigurationName
extends java.lang.Enum<ConfigurationName>
```
The names of Gradle configurations used by the Spine model compiler plugin.
See the Gradle doc on dependency configurations for more info.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`annotationProcessor` The annotation processors used during the compilation of this module.
`api` The API of a Java library.
`classpath` The classpath of the Gradle build process.
`compile` Deprecated. Deprecated since Gradle 5.0. Use `implementation` or `api` instead.
`compileClasspath` All the dependencies included for the Java module compilation.
`compileOnly` Dependencies available at compile-time but not at runtime.
`fetch` A Spine-specific configuration used to download and resolve artifacts.
`implementation` Dependencies on which the Java module relies for implementation.
`protobuf` Configuration that allows to compile `.proto` files form the dependencies.
`runtimeClasspath` All the dependencies included for the Java module runtime.
`runtimeOnly` Dependencies available at runtime but not at compile-time.
`testAnnotationProcessor` The annotation processors used during the compilation of the tests of this module.
`testCompileClasspath` All the dependencies included for the Java module tests compilation.
`testImplementation` Dependencies on which the Java module tests rely for implementation.
`testRuntimeClasspath` All the dependencies included for the Java module test runtime.
`testRuntimeOnly` Dependencies available at test runtime but not at compile-time.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`value()`
`static ConfigurationName`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ConfigurationName[]`	`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
  - classpath
```
public static final ConfigurationName classpath
```
    The classpath of the Gradle build process.
  - annotationProcessor
```
public static final ConfigurationName annotationProcessor
```
    The annotation processors used during the compilation of this module.
    These dependencies are not accessible to the user at compile-time or at runtime directly.
  - api
```
public static final ConfigurationName api
```
    The API of a Java library.
    The dependencies are available at compile-time and runtime.
    Dependencies in this configuration are included as compile-time transitive dependencies in the artifacts of the library.
  - implementation
```
public static final ConfigurationName implementation
```
    Dependencies on which the Java module relies for implementation.
    The dependencies are available at compile-time and runtime.
    Dependencies in this configuration are included as runtime transitive dependencies in the artifacts of the module.
  - compileOnly
```
public static final ConfigurationName compileOnly
```
    Dependencies available at compile-time but not at runtime.
    Suitable for annotations with RetentionPolicy.CLASS.
  - compileClasspath
```
public static final ConfigurationName compileClasspath
```
    All the dependencies included for the Java module compilation.
    Users cannot add dependencies directly to this configuration. However, this configuration may be resolved.
  - runtimeOnly
```
public static final ConfigurationName runtimeOnly
```
    Dependencies available at runtime but not at compile-time.
    Suitable for SPI implementations loaded via ServiceLoader or other classpath scanning utilities.
  - runtimeClasspath
```
public static final ConfigurationName runtimeClasspath
```
    All the dependencies included for the Java module runtime.
    Users cannot add dependencies directly to this configuration. However, this configuration may be resolved.
  - testAnnotationProcessor
```
public static final ConfigurationName testAnnotationProcessor
```
    The annotation processors used during the compilation of the tests of this module.
    These dependencies are not accessible to the user at compile-time or at runtime directly.
  - testImplementation
```
public static final ConfigurationName testImplementation
```
    Dependencies on which the Java module tests rely for implementation.
    The dependencies are available at compile-time of the test code and at the test runtime.
  - testCompileClasspath
```
public static final ConfigurationName testCompileClasspath
```
    All the dependencies included for the Java module tests compilation.
    Users cannot add dependencies directly to this configuration. However, this configuration may be resolved.
  - testRuntimeOnly
```
public static final ConfigurationName testRuntimeOnly
```
    Dependencies available at test runtime but not at compile-time.
    For example, JUnit runners may be depended on with this configuration.
  - testRuntimeClasspath
```
public static final ConfigurationName testRuntimeClasspath
```
    All the dependencies included for the Java module test runtime.
    Users cannot add dependencies directly to this configuration. However, this configuration may be resolved.
  - protobuf
```
public static final ConfigurationName protobuf
```
    Configuration that allows to compile .proto files form the dependencies.
    Users should use compile when adding Protobuf dependencies to other strictly Protobuf modules.
  - fetch
```
@Internal
public static final ConfigurationName fetch
```
    A Spine-specific configuration used to download and resolve artifacts.
  - compile
```
@Deprecated
public static final ConfigurationName compile
```
    Deprecated. Deprecated since Gradle 5.0. Use implementation or api instead.
    
    The compile configuration.
- Method Detail
  - values
```
public static ConfigurationName[] 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 (ConfigurationName c : ConfigurationName.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ConfigurationName 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
  - value
```
public java.lang.String value()
```

Enum ConfigurationName

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

classpath

annotationProcessor

api

implementation

compileOnly

compileClasspath

runtimeOnly

runtimeClasspath

testAnnotationProcessor

testImplementation

testCompileClasspath

testRuntimeOnly

testRuntimeClasspath

protobuf

fetch

compile

Method Detail

values

valueOf

value