Package io.github.cdklabs.projen.java

Interface JavaProjectOptions

All Superinterfaces:

GitHubProjectOptions, JavaProjectCommonOptions, software.amazon.jsii.JsiiSerializable, PomOptions, ProjectOptions

All Known Subinterfaces:

AwsCdkJavaAppOptions

All Known Implementing Classes:

AwsCdkJavaAppOptions.Jsii$Proxy, JavaProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.142Z")
@Stability(Experimental)
public interface JavaProjectOptions
extends software.amazon.jsii.JsiiSerializable, JavaProjectCommonOptions

(experimental) Options for JavaProject.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JavaProjectOptions.Builder	A builder for JavaProjectOptions
static class	JavaProjectOptions.Jsii$Proxy	An implementation for JavaProjectOptions

Method Summary

Modifier and Type	Method	Description
static JavaProjectOptions.Builder	builder()
default Boolean	getSample()	(experimental) Include sample code and test if the relevant directories don't exist.
default String	getSampleJavaPackage()	(experimental) The java package to use for the code sample.

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

getAutoApproveOptions, getAutoMerge, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getProjenCredentials, getProjenTokenSecret, getReadme, getStale, getStaleOptions, getVscode

Methods inherited from interface io.github.cdklabs.projen.java.JavaProjectCommonOptions

getCompileOptions, getDeps, getDistdir, getJunit, getJunitOptions, getPackagingOptions, getProjenrcJava, getProjenrcJavaOptions, getTestDeps

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.java.PomOptions

getArtifactId, getDescription, getGroupId, getPackaging, getParentPom, getUrl, getVersion

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

getCommitGenerated, getGitIgnoreOptions, getGitOptions, getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions, getRenovatebot, getRenovatebotOptions

Method Detail

getSample

@Stability(Experimental)
@Nullable
default Boolean getSample()

(experimental) Include sample code and test if the relevant directories don't exist.

Default: true

getSampleJavaPackage

@Stability(Experimental)
@Nullable
default String getSampleJavaPackage()

(experimental) The java package to use for the code sample.

Default: "org.acme"

builder

@Stability(Experimental)
static JavaProjectOptions.Builder builder()

Returns:

a JavaProjectOptions.Builder of JavaProjectOptions