Package io.github.cdklabs.projen.java

Class JavaProject

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Project

io.github.cdklabs.projen.github.GitHubProject

io.github.cdklabs.projen.java.JavaProject

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

AwsCdkJavaApp

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.137Z")
@Stability(Experimental)
public class JavaProject
extends GitHubProject

(experimental) Java project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaProject.Builder	(experimental) A fluent builder for JavaProject.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Field Summary

Fields inherited from class io.github.cdklabs.projen.Project

DEFAULT_TASK

Constructor Summary

Constructors

Modifier	Constructor	Description
	JavaProject(JavaProjectOptions options)
protected	JavaProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	JavaProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addDependency(String spec)	(experimental) Adds a runtime dependency.
Dependency	addPlugin(String spec)	(experimental) Adds a build plugin to the pom.
Dependency	addPlugin(String spec, PluginOptions options)	(experimental) Adds a build plugin to the pom.
void	addTestDependency(String spec)	(experimental) Adds a test dependency.
MavenCompile	getCompile()	(experimental) Compile component.
String	getDistdir()	(experimental) Maven artifact output directory.
Junit	getJunit()	(experimental) JUnit component.
MavenPackaging	getPackaging()	(experimental) Packaging component.
Pom	getPom()	(experimental) API for managing pom.xml.
Projenrc	getProjenrc()	(experimental) Projenrc component.

Methods inherited from class io.github.cdklabs.projen.github.GitHubProject

annotateGenerated, getAutoApprove, getDevContainer, getGithub, getGitpod, getProjectType, getVscode

Methods inherited from class io.github.cdklabs.projen.Project

addExcludeFromCleanup, addGitIgnore, addPackageIgnore, addTask, addTask, addTip, getBuildTask, getCommitGenerated, getCompileTask, getComponents, getDefaultTask, getDeps, getEjected, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getSubprojects, getTasks, getTestTask, isProject, of, postSynthesize, preSynthesize, removeTask, runTaskCommand, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

JavaProject

protected JavaProject(software.amazon.jsii.JsiiObjectRef objRef)

JavaProject

protected JavaProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

JavaProject

@Stability(Experimental)
public JavaProject(@NotNull
                   JavaProjectOptions options)

Parameters:

options - This parameter is required.

Method Detail

addDependency

@Stability(Experimental)
public void addDependency(@NotNull
                          String spec)

(experimental) Adds a runtime dependency.

Parameters:

spec - Format <groupId>/<artifactId>@<semver>. This parameter is required.

addPlugin

@Stability(Experimental)
@NotNull
public Dependency addPlugin(@NotNull
                            String spec,
                            @Nullable
                            PluginOptions options)

(experimental) Adds a build plugin to the pom.

The plug in is also added as a BUILD dep to the project.

Parameters:

spec - dependency spec (group/artifact@version). This parameter is required.

options - plugin options.

addPlugin

@Stability(Experimental)
@NotNull
public Dependency addPlugin(@NotNull
                            String spec)

(experimental) Adds a build plugin to the pom.

The plug in is also added as a BUILD dep to the project.

Parameters:

spec - dependency spec (group/artifact@version). This parameter is required.

addTestDependency

@Stability(Experimental)
public void addTestDependency(@NotNull
                              String spec)

(experimental) Adds a test dependency.

Parameters:

spec - Format <groupId>/<artifactId>@<semver>. This parameter is required.

getCompile

@Stability(Experimental)
@NotNull
public MavenCompile getCompile()

(experimental) Compile component.

getDistdir

@Stability(Experimental)
@NotNull
public String getDistdir()

(experimental) Maven artifact output directory.

getPackaging

@Stability(Experimental)
@NotNull
public MavenPackaging getPackaging()

(experimental) Packaging component.

getPom

@Stability(Experimental)
@NotNull
public Pom getPom()

(experimental) API for managing pom.xml.

getJunit

@Stability(Experimental)
@Nullable
public Junit getJunit()

(experimental) JUnit component.

getProjenrc

@Stability(Experimental)
@Nullable
public Projenrc getProjenrc()

(experimental) Projenrc component.