Package io.github.cdklabs.projen.java

Class Projenrc.Builder

java.lang.Object

io.github.cdklabs.projen.java.Projenrc.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Projenrc>

Enclosing class:

Projenrc

@Stability(Experimental)
public static final class Projenrc.Builder
extends Object
implements software.amazon.jsii.Builder<Projenrc>

(experimental) A fluent builder for Projenrc.

Method Summary

Modifier and Type	Method	Description
Projenrc	build()
Projenrc.Builder	className(String className)	(experimental) The name of the Java class which contains the main() method for projen.
static Projenrc.Builder	create(Project project, Pom pom)
Projenrc.Builder	projenVersion(String projenVersion)	(experimental) The projen version to use.
Projenrc.Builder	testScope(Boolean testScope)	(experimental) Defines projenrc under the test scope instead of the main scope, which is reserved to the app.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Experimental)
public static Projenrc.Builder create(Project project,
                                      Pom pom)

Parameters:

project - This parameter is required.

pom - This parameter is required.

Returns:

a new instance of Projenrc.Builder.

className

@Stability(Experimental)
public Projenrc.Builder className(String className)

(experimental) The name of the Java class which contains the main() method for projen.

Default: "projenrc"

Parameters:

className - The name of the Java class which contains the main() method for projen. This parameter is required.

Returns:

this

projenVersion

@Stability(Experimental)
public Projenrc.Builder projenVersion(String projenVersion)

(experimental) The projen version to use.

Default: - current version

Parameters:

projenVersion - The projen version to use. This parameter is required.

Returns:

this

testScope

@Stability(Experimental)
public Projenrc.Builder testScope(Boolean testScope)

(experimental) Defines projenrc under the test scope instead of the main scope, which is reserved to the app.

This means that projenrc will be under src/test/java/projenrc.java and projen will be defined as a test dependency. This enforces that application code does not take a dependency on projen code.

If this is disabled, projenrc should be under src/main/java/projenrc.java.

Default: true

Parameters:

testScope - Defines projenrc under the test scope instead of the main scope, which is reserved to the app. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public Projenrc build()

Specified by:

build in interface software.amazon.jsii.Builder<Projenrc>

Returns:

a newly built instance of Projenrc.