Package io.github.cdklabs.projen.java

Interface JavaProjectCommonOptions

All Superinterfaces:

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

All Known Subinterfaces:

AwsCdkJavaAppOptions, JavaProjectOptions

All Known Implementing Classes:

AwsCdkJavaAppOptions.Jsii$Proxy, JavaProjectCommonOptions.Jsii$Proxy, JavaProjectOptions.Jsii$Proxy

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

(experimental) Options for JavaProject.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JavaProjectCommonOptions.Builder	builder()
default MavenCompileOptions	getCompileOptions()	(experimental) Compile options.
default List<String>	getDeps()	(experimental) List of runtime dependencies for this project.
default String	getDistdir()	(experimental) Final artifact output directory.
default Boolean	getJunit()	(experimental) Include junit tests.
default JunitOptions	getJunitOptions()	(experimental) junit options.
default MavenPackagingOptions	getPackagingOptions()	(experimental) Packaging options.
default Boolean	getProjenrcJava()	(experimental) Use projenrc in java.
default ProjenrcOptions	getProjenrcJavaOptions()	(experimental) Options related to projenrc in java.
default List<String>	getTestDeps()	(experimental) List of test dependencies for this project.

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 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

getCompileOptions

@Stability(Experimental)
@Nullable
default MavenCompileOptions getCompileOptions()

(experimental) Compile options.

Default: - defaults

getDeps

@Stability(Experimental)
@Nullable
default List<String> getDeps()

(experimental) List of runtime dependencies for this project.

Dependencies use the format: <groupId>/<artifactId>@<semver>

Additional dependencies can be added via project.addDependency().

Default: []

getDistdir

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

(experimental) Final artifact output directory.

Default: "dist/java"

getJunit

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

(experimental) Include junit tests.

Default: true

getJunitOptions

@Stability(Experimental)
@Nullable
default JunitOptions getJunitOptions()

(experimental) junit options.

Default: - defaults

getPackagingOptions

@Stability(Experimental)
@Nullable
default MavenPackagingOptions getPackagingOptions()

(experimental) Packaging options.

Default: - defaults

getProjenrcJava

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

(experimental) Use projenrc in java.

This will install projen as a java dependency and will add a synth task which will compile & execute main() from src/main/java/projenrc.java.

Default: true

getProjenrcJavaOptions

@Stability(Experimental)
@Nullable
default ProjenrcOptions getProjenrcJavaOptions()

(experimental) Options related to projenrc in java.

Default: - default options

getTestDeps

@Stability(Experimental)
@Nullable
default List<String> getTestDeps()

(experimental) List of test dependencies for this project.

Dependencies use the format: <groupId>/<artifactId>@<semver>

Additional dependencies can be added via project.addTestDependency().

Default: []

builder

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

Returns:

a JavaProjectCommonOptions.Builder of JavaProjectCommonOptions