io.github.cdklabs.projen.java

Class JavaProjectCommonOptions.Builder

java.lang.Object

io.github.cdklabs.projen.java.JavaProjectCommonOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JavaProjectCommonOptions>

Enclosing interface:

JavaProjectCommonOptions

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

A builder for JavaProjectCommonOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JavaProjectCommonOptions.Builder	artifactId(String artifactId) Sets the value of PomOptions.getArtifactId()
JavaProjectCommonOptions.Builder	autoApproveOptions(AutoApproveOptions autoApproveOptions) Sets the value of GitHubProjectOptions.getAutoApproveOptions()
JavaProjectCommonOptions.Builder	autoMergeOptions(AutoMergeOptions autoMergeOptions) Sets the value of GitHubProjectOptions.getAutoMergeOptions()
JavaProjectCommonOptions	build() Builds the configured instance.
JavaProjectCommonOptions.Builder	clobber(Boolean clobber) Sets the value of GitHubProjectOptions.getClobber()
JavaProjectCommonOptions.Builder	compileOptions(MavenCompileOptions compileOptions) Sets the value of JavaProjectCommonOptions.getCompileOptions()
JavaProjectCommonOptions.Builder	deps(List<String> deps) Sets the value of JavaProjectCommonOptions.getDeps()
JavaProjectCommonOptions.Builder	description(String description) Sets the value of PomOptions.getDescription()
JavaProjectCommonOptions.Builder	devContainer(Boolean devContainer) Sets the value of GitHubProjectOptions.getDevContainer()
JavaProjectCommonOptions.Builder	distdir(String distdir) Sets the value of JavaProjectCommonOptions.getDistdir()
JavaProjectCommonOptions.Builder	github(Boolean github) Sets the value of GitHubProjectOptions.getGithub()
JavaProjectCommonOptions.Builder	githubOptions(GitHubOptions githubOptions) Sets the value of GitHubProjectOptions.getGithubOptions()
JavaProjectCommonOptions.Builder	gitpod(Boolean gitpod) Sets the value of GitHubProjectOptions.getGitpod()
JavaProjectCommonOptions.Builder	groupId(String groupId) Sets the value of PomOptions.getGroupId()
JavaProjectCommonOptions.Builder	junit(Boolean junit) Sets the value of JavaProjectCommonOptions.getJunit()
JavaProjectCommonOptions.Builder	junitOptions(JunitOptions junitOptions) Sets the value of JavaProjectCommonOptions.getJunitOptions()
JavaProjectCommonOptions.Builder	logging(LoggerOptions logging) Sets the value of ProjectOptions.getLogging()
JavaProjectCommonOptions.Builder	mergify(Boolean mergify) Deprecated. use `githubOptions.mergify` instead
JavaProjectCommonOptions.Builder	mergifyOptions(MergifyOptions mergifyOptions) Deprecated. use `githubOptions.mergifyOptions` instead
JavaProjectCommonOptions.Builder	name(String name) Sets the value of ProjectOptions.getName()
JavaProjectCommonOptions.Builder	outdir(String outdir) Sets the value of ProjectOptions.getOutdir()
JavaProjectCommonOptions.Builder	packaging(String packaging) Sets the value of PomOptions.getPackaging()
JavaProjectCommonOptions.Builder	packagingOptions(MavenPackagingOptions packagingOptions) Sets the value of JavaProjectCommonOptions.getPackagingOptions()
JavaProjectCommonOptions.Builder	parent(Project parent) Sets the value of ProjectOptions.getParent()
JavaProjectCommonOptions.Builder	projectType(ProjectType projectType) Deprecated. no longer supported at the base project level
JavaProjectCommonOptions.Builder	projenCommand(String projenCommand) Sets the value of ProjectOptions.getProjenCommand()
JavaProjectCommonOptions.Builder	projenrcJava(Boolean projenrcJava) Sets the value of JavaProjectCommonOptions.getProjenrcJava()
JavaProjectCommonOptions.Builder	projenrcJavaOptions(ProjenrcOptions projenrcJavaOptions) Sets the value of JavaProjectCommonOptions.getProjenrcJavaOptions()
JavaProjectCommonOptions.Builder	projenrcJson(Boolean projenrcJson) Sets the value of ProjectOptions.getProjenrcJson()
JavaProjectCommonOptions.Builder	projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions) Sets the value of ProjectOptions.getProjenrcJsonOptions()
JavaProjectCommonOptions.Builder	readme(SampleReadmeProps readme) Sets the value of GitHubProjectOptions.getReadme()
JavaProjectCommonOptions.Builder	stale(Boolean stale) Sets the value of GitHubProjectOptions.getStale()
JavaProjectCommonOptions.Builder	staleOptions(StaleOptions staleOptions) Sets the value of GitHubProjectOptions.getStaleOptions()
JavaProjectCommonOptions.Builder	testDeps(List<String> testDeps) Sets the value of JavaProjectCommonOptions.getTestDeps()
JavaProjectCommonOptions.Builder	url(String url) Sets the value of PomOptions.getUrl()
JavaProjectCommonOptions.Builder	version(String version) Sets the value of PomOptions.getVersion()
JavaProjectCommonOptions.Builder	vscode(Boolean vscode) Sets the value of GitHubProjectOptions.getVscode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

compileOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder compileOptions(MavenCompileOptions compileOptions)

Sets the value of JavaProjectCommonOptions.getCompileOptions()

Parameters:

compileOptions - Compile options.

Returns:

this

deps

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder deps(List<String> deps)

Sets the value of JavaProjectCommonOptions.getDeps()

Parameters:

deps - List of runtime dependencies for this project. Dependencies use the format: <groupId>/<artifactId>@<semver>

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

Returns:

this

distdir

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder distdir(String distdir)

Sets the value of JavaProjectCommonOptions.getDistdir()

Parameters:

distdir - Final artifact output directory.

Returns:

this

junit

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder junit(Boolean junit)

Sets the value of JavaProjectCommonOptions.getJunit()

Parameters:

junit - Include junit tests.

Returns:

this

junitOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder junitOptions(JunitOptions junitOptions)

Sets the value of JavaProjectCommonOptions.getJunitOptions()

Parameters:

junitOptions - junit options.

Returns:

this

packagingOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder packagingOptions(MavenPackagingOptions packagingOptions)

Sets the value of JavaProjectCommonOptions.getPackagingOptions()

Parameters:

packagingOptions - Packaging options.

Returns:

this

projenrcJava

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder projenrcJava(Boolean projenrcJava)

Sets the value of JavaProjectCommonOptions.getProjenrcJava()

Parameters:

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

Returns:

this

projenrcJavaOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder projenrcJavaOptions(ProjenrcOptions projenrcJavaOptions)

Sets the value of JavaProjectCommonOptions.getProjenrcJavaOptions()

Parameters:

projenrcJavaOptions - Options related to projenrc in java.

Returns:

this

testDeps

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder testDeps(List<String> testDeps)

Sets the value of JavaProjectCommonOptions.getTestDeps()

Parameters:

testDeps - List of test dependencies for this project. Dependencies use the format: <groupId>/<artifactId>@<semver>

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

Returns:

this

autoApproveOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)

Sets the value of GitHubProjectOptions.getAutoApproveOptions()

Parameters:

autoApproveOptions - Enable and configure the 'auto approve' workflow.

Returns:

this

autoMergeOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)

Sets the value of GitHubProjectOptions.getAutoMergeOptions()

Parameters:

autoMergeOptions - Configure options for automatic merging on GitHub. Has no effect if github.mergify is set to false.

Returns:

this

clobber

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder clobber(Boolean clobber)

Sets the value of GitHubProjectOptions.getClobber()

Parameters:

clobber - Add a `clobber` task which resets the repo to origin.

Returns:

this

devContainer

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder devContainer(Boolean devContainer)

Sets the value of GitHubProjectOptions.getDevContainer()

Parameters:

devContainer - Add a VSCode development environment (used for GitHub Codespaces).

Returns:

this

github

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder github(Boolean github)

Sets the value of GitHubProjectOptions.getGithub()

Parameters:

github - Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects.

Returns:

this

githubOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder githubOptions(GitHubOptions githubOptions)

Sets the value of GitHubProjectOptions.getGithubOptions()

Parameters:

githubOptions - Options for GitHub integration.

Returns:

this

gitpod

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder gitpod(Boolean gitpod)

Sets the value of GitHubProjectOptions.getGitpod()

Parameters:

gitpod - Add a Gitpod development environment.

Returns:

this

mergify

@Stability(value=Deprecated)
 @Deprecated
public JavaProjectCommonOptions.Builder mergify(Boolean mergify)

Deprecated. use `githubOptions.mergify` instead

Sets the value of GitHubProjectOptions.getMergify()

Parameters:

mergify - Whether mergify should be enabled on this repository or not.

Returns:

this

mergifyOptions

@Stability(value=Deprecated)
 @Deprecated
public JavaProjectCommonOptions.Builder mergifyOptions(MergifyOptions mergifyOptions)

Deprecated. use `githubOptions.mergifyOptions` instead

Sets the value of GitHubProjectOptions.getMergifyOptions()

Parameters:

mergifyOptions - Options for mergify.

Returns:

this

projectType

@Stability(value=Deprecated)
 @Deprecated
public JavaProjectCommonOptions.Builder projectType(ProjectType projectType)

Deprecated. no longer supported at the base project level

Sets the value of GitHubProjectOptions.getProjectType()

Parameters:

projectType - Which type of project this is (library/app).

Returns:

this

readme

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder readme(SampleReadmeProps readme)

Sets the value of GitHubProjectOptions.getReadme()

Parameters:

readme - The README setup.

Returns:

this

stale

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder stale(Boolean stale)

Sets the value of GitHubProjectOptions.getStale()

Parameters:

stale - Auto-close of stale issues and pull request. See staleOptions for options.

Returns:

this

staleOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder staleOptions(StaleOptions staleOptions)

Sets the value of GitHubProjectOptions.getStaleOptions()

Parameters:

staleOptions - Auto-close stale issues and pull requests. To disable set stale to false.

Returns:

this

vscode

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder vscode(Boolean vscode)

Sets the value of GitHubProjectOptions.getVscode()

Parameters:

vscode - Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects.

Returns:

this

name

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder name(String name)

Sets the value of ProjectOptions.getName()

Parameters:

name - This is the name of your project. This parameter is required.

Returns:

this

logging

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder logging(LoggerOptions logging)

Sets the value of ProjectOptions.getLogging()

Parameters:

logging - Configure logging options such as verbosity.

Returns:

this

outdir

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder outdir(String outdir)

Sets the value of ProjectOptions.getOutdir()

Parameters:

outdir - The root directory of the project. Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.

Returns:

this

parent

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder parent(Project parent)

Sets the value of ProjectOptions.getParent()

Parameters:

parent - The parent project, if this project is part of a bigger project.

Returns:

this

projenCommand

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder projenCommand(String projenCommand)

Sets the value of ProjectOptions.getProjenCommand()

Parameters:

projenCommand - The shell command to use in order to run the projen CLI. Can be used to customize in special environments.

Returns:

this

projenrcJson

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder projenrcJson(Boolean projenrcJson)

Sets the value of ProjectOptions.getProjenrcJson()

Parameters:

projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.

Returns:

this

projenrcJsonOptions

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)

Sets the value of ProjectOptions.getProjenrcJsonOptions()

Parameters:

projenrcJsonOptions - Options for .projenrc.json.

Returns:

this

artifactId

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder artifactId(String artifactId)

Sets the value of PomOptions.getArtifactId()

Parameters:

artifactId - The artifactId is generally the name that the project is known by. This parameter is required. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project.

Returns:

this

groupId

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder groupId(String groupId)

Sets the value of PomOptions.getGroupId()

Parameters:

groupId - This is generally unique amongst an organization or a project. This parameter is required. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo.

Returns:

this

version

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder version(String version)

Sets the value of PomOptions.getVersion()

Parameters:

version - This is the last piece of the naming puzzle. This parameter is required. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0.

Returns:

this

description

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder description(String description)

Sets the value of PomOptions.getDescription()

Parameters:

description - Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful.

Returns:

this

packaging

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder packaging(String packaging)

Sets the value of PomOptions.getPackaging()

Parameters:

packaging - Project packaging format.

Returns:

this

url

@Stability(value=Experimental)
public JavaProjectCommonOptions.Builder url(String url)

Sets the value of PomOptions.getUrl()

Parameters:

url - The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives.

Returns:

this

build

@Stability(value=Experimental)
public JavaProjectCommonOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of JavaProjectCommonOptions

Throws:

NullPointerException - if any required attribute was not provided