JavaProjectOptions.Jsii$Proxy (io.github.cdklabs:projen 0.45.3 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - io.github.cdklabs.projen.java.JavaProjectOptions.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

JavaProjectOptions
```
@Stability(value=Experimental)
 @Internal
public static final class JavaProjectOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements JavaProjectOptions
```
An implementation for JavaProjectOptions

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface io.github.cdklabs.projen.java.JavaProjectOptions
  JavaProjectOptions.Builder, JavaProjectOptions.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(JavaProjectOptions.Builder builder)` Constructor that initializes the object based on literal property values passed by the `JavaProjectOptions.Builder`.
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`String`	`getArtifactId()` (experimental) The artifactId is generally the name that the project is known by.
`AutoApproveOptions`	`getAutoApproveOptions()` (experimental) Enable and configure the 'auto approve' workflow.
`AutoMergeOptions`	`getAutoMergeOptions()` (experimental) Configure options for automatic merging on GitHub.
`Boolean`	`getClobber()` (experimental) Add a `clobber` task which resets the repo to origin.
`MavenCompileOptions`	`getCompileOptions()` (experimental) Compile options.
`List<String>`	`getDeps()` (experimental) List of runtime dependencies for this project.
`String`	`getDescription()` (experimental) Description of a project is always good.
`Boolean`	`getDevContainer()` (experimental) Add a VSCode development environment (used for GitHub Codespaces).
`String`	`getDistdir()` (experimental) Final artifact output directory.
`Boolean`	`getGithub()` (experimental) Enable GitHub integration.
`GitHubOptions`	`getGithubOptions()` (experimental) Options for GitHub integration.
`Boolean`	`getGitpod()` (experimental) Add a Gitpod development environment.
`String`	`getGroupId()` (experimental) This is generally unique amongst an organization or a project.
`Boolean`	`getJunit()` (experimental) Include junit tests.
`JunitOptions`	`getJunitOptions()` (experimental) junit options.
`LoggerOptions`	`getLogging()` (experimental) Configure logging options such as verbosity.
`Boolean`	`getMergify()` (deprecated) Whether mergify should be enabled on this repository or not.
`MergifyOptions`	`getMergifyOptions()` (deprecated) Options for mergify.
`String`	`getName()` (experimental) This is the name of your project.
`String`	`getOutdir()` (experimental) The root directory of the project.
`String`	`getPackaging()` (experimental) Project packaging format.
`MavenPackagingOptions`	`getPackagingOptions()` (experimental) Packaging options.
`Project`	`getParent()` (experimental) The parent project, if this project is part of a bigger project.
`ProjectType`	`getProjectType()` (deprecated) Which type of project this is (library/app).
`String`	`getProjenCommand()` (experimental) The shell command to use in order to run the projen CLI.
`Boolean`	`getProjenrcJava()` (experimental) Use projenrc in java.
`ProjenrcOptions`	`getProjenrcJavaOptions()` (experimental) Options related to projenrc in java.
`Boolean`	`getProjenrcJson()` (experimental) Generate (once) .projenrc.json (in JSON).
`ProjenrcOptions`	`getProjenrcJsonOptions()` (experimental) Options for .projenrc.json.
`SampleReadmeProps`	`getReadme()` (experimental) The README setup.
`Boolean`	`getSample()` (experimental) Include sample code and test if the relevant directories don't exist.
`String`	`getSampleJavaPackage()` (experimental) The java package to use for the code sample.
`Boolean`	`getStale()` (experimental) Auto-close of stale issues and pull request.
`StaleOptions`	`getStaleOptions()` (experimental) Auto-close stale issues and pull requests.
`List<String>`	`getTestDeps()` (experimental) List of test dependencies for this project.
`String`	`getUrl()` (experimental) The URL, like the name, is not required.
`String`	`getVersion()` (experimental) This is the last piece of the naming puzzle.
`Boolean`	`getVscode()` (experimental) Enable VSCode integration.
`int`	`hashCode()`

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.cdklabs.projen.java.JavaProjectOptions
builder

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
  - Jsii$Proxy
```
protected Jsii$Proxy(JavaProjectOptions.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the JavaProjectOptions.Builder.
- Method Detail
  - getSample
```
public final Boolean getSample()
```
    Description copied from interface: JavaProjectOptions
    
    (experimental) Include sample code and test if the relevant directories don't exist.
    
    Specified by:
    
    getSample in interface JavaProjectOptions
  - getSampleJavaPackage
```
public final String getSampleJavaPackage()
```
    Description copied from interface: JavaProjectOptions
    
    (experimental) The java package to use for the code sample.
    Default: "org.acme"
    
    Specified by:
    
    getSampleJavaPackage in interface JavaProjectOptions
  - getCompileOptions
```
public final MavenCompileOptions getCompileOptions()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) Compile options.
    Default: - defaults
    
    Specified by:
    
    getCompileOptions in interface JavaProjectCommonOptions
  - getDeps
```
public final List<String> getDeps()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) List of runtime dependencies for this project.
    Dependencies use the format: <groupId>/<artifactId>@<semver>
    Additional dependencies can be added via project.addDependency().
    Default: []
    
    Specified by:
    
    getDeps in interface JavaProjectCommonOptions
  - getDistdir
```
public final String getDistdir()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) Final artifact output directory.
    Default: "dist/java"
    
    Specified by:
    
    getDistdir in interface JavaProjectCommonOptions
  - getJunit
```
public final Boolean getJunit()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) Include junit tests.
    Default: true
    
    Specified by:
    
    getJunit in interface JavaProjectCommonOptions
  - getJunitOptions
```
public final JunitOptions getJunitOptions()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) junit options.
    Default: - defaults
    
    Specified by:
    
    getJunitOptions in interface JavaProjectCommonOptions
  - getPackagingOptions
```
public final MavenPackagingOptions getPackagingOptions()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) Packaging options.
    Default: - defaults
    
    Specified by:
    
    getPackagingOptions in interface JavaProjectCommonOptions
  - getProjenrcJava
```
public final Boolean getProjenrcJava()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (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
    
    Specified by:
    
    getProjenrcJava in interface JavaProjectCommonOptions
  - getProjenrcJavaOptions
```
public final ProjenrcOptions getProjenrcJavaOptions()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) Options related to projenrc in java.
    Default: - default options
    
    Specified by:
    
    getProjenrcJavaOptions in interface JavaProjectCommonOptions
  - getTestDeps
```
public final List<String> getTestDeps()
```
    Description copied from interface: JavaProjectCommonOptions
    
    (experimental) List of test dependencies for this project.
    Dependencies use the format: <groupId>/<artifactId>@<semver>
    Additional dependencies can be added via project.addTestDependency().
    Default: []
    
    Specified by:
    
    getTestDeps in interface JavaProjectCommonOptions
  - getAutoApproveOptions
```
public final AutoApproveOptions getAutoApproveOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable and configure the 'auto approve' workflow.
    Default: - auto approve is disabled
    
    Specified by:
    
    getAutoApproveOptions in interface GitHubProjectOptions
  - getAutoMergeOptions
```
public final AutoMergeOptions getAutoMergeOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Configure options for automatic merging on GitHub.
    Has no effect if github.mergify is set to false.
    Default: - see defaults in `AutoMergeOptions`
    
    Specified by:
    
    getAutoMergeOptions in interface GitHubProjectOptions
  - getClobber
```
public final Boolean getClobber()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a `clobber` task which resets the repo to origin.
    Default: true
    
    Specified by:
    
    getClobber in interface GitHubProjectOptions
  - getDevContainer
```
public final Boolean getDevContainer()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a VSCode development environment (used for GitHub Codespaces).
    Default: false
    
    Specified by:
    
    getDevContainer in interface GitHubProjectOptions
  - getGithub
```
public final Boolean getGithub()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable GitHub integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Specified by:
    
    getGithub in interface GitHubProjectOptions
  - getGithubOptions
```
public final GitHubOptions getGithubOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Options for GitHub integration.
    Default: - see GitHubOptions
    
    Specified by:
    
    getGithubOptions in interface GitHubProjectOptions
  - getGitpod
```
public final Boolean getGitpod()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a Gitpod development environment.
    Default: false
    
    Specified by:
    
    getGitpod in interface GitHubProjectOptions
  - getMergify
```
public final Boolean getMergify()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Whether mergify should be enabled on this repository or not.
    Default: true
    
    Specified by:
    
    getMergify in interface GitHubProjectOptions
  - getMergifyOptions
```
public final MergifyOptions getMergifyOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Options for mergify.
    Default: - default options
    
    Specified by:
    
    getMergifyOptions in interface GitHubProjectOptions
  - getProjectType
```
public final ProjectType getProjectType()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Which type of project this is (library/app).
    Default: ProjectType.UNKNOWN
    
    Specified by:
    
    getProjectType in interface GitHubProjectOptions
  - getReadme
```
public final SampleReadmeProps getReadme()
```
    Description copied from interface: GitHubProjectOptions
    (experimental) The README setup.
    Default: - { filename: 'README.md', contents: '# replace this' }
    Example:
    // Example automatically generated from non-compiling source. May contain errors. "{ filename: 'readme.md', contents: '# title' }"
    Specified by:
    
    getReadme in interface GitHubProjectOptions
  - getStale
```
public final Boolean getStale()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Auto-close of stale issues and pull request.
    See staleOptions for options.
    Default: true
    
    Specified by:
    
    getStale in interface GitHubProjectOptions
  - getStaleOptions
```
public final StaleOptions getStaleOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Auto-close stale issues and pull requests.
    To disable set stale to false.
    Default: - see defaults in `StaleOptions`
    
    Specified by:
    
    getStaleOptions in interface GitHubProjectOptions
  - getVscode
```
public final Boolean getVscode()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable VSCode integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Specified by:
    
    getVscode in interface GitHubProjectOptions
  - getName
```
public final String getName()
```
    Description copied from interface: ProjectOptions
    
    (experimental) This is the name of your project.
    Default: $BASEDIR
    
    Specified by:
    
    getName in interface ProjectOptions
  - getLogging
```
public final LoggerOptions getLogging()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Configure logging options such as verbosity.
    Default: {}
    
    Specified by:
    
    getLogging in interface ProjectOptions
  - getOutdir
```
public final String getOutdir()
```
    Description copied from interface: ProjectOptions
    
    (experimental) 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.
    Default: "."
    
    Specified by:
    
    getOutdir in interface ProjectOptions
  - getParent
```
public final Project getParent()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The parent project, if this project is part of a bigger project.
    
    Specified by:
    
    getParent in interface ProjectOptions
  - getProjenCommand
```
public final String getProjenCommand()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The shell command to use in order to run the projen CLI.
    Can be used to customize in special environments.
    Default: "npx projen"
    
    Specified by:
    
    getProjenCommand in interface ProjectOptions
  - getProjenrcJson
```
public final Boolean getProjenrcJson()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
    Default: false
    
    Specified by:
    
    getProjenrcJson in interface ProjectOptions
  - getProjenrcJsonOptions
```
public final ProjenrcOptions getProjenrcJsonOptions()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Options for .projenrc.json.
    Default: - default options
    
    Specified by:
    
    getProjenrcJsonOptions in interface ProjectOptions
  - getArtifactId
```
public final String getArtifactId()
```
    Description copied from interface: PomOptions
    
    (experimental) The artifactId is generally the name that the project is known by.
    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.
    Default: "my-app"
    
    Specified by:
    
    getArtifactId in interface PomOptions
  - getGroupId
```
public final String getGroupId()
```
    Description copied from interface: PomOptions
    
    (experimental) This is generally unique amongst an organization or a project.
    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.
    Default: "org.acme"
    
    Specified by:
    
    getGroupId in interface PomOptions
  - getVersion
```
public final String getVersion()
```
    Description copied from interface: PomOptions
    
    (experimental) This is the last piece of the naming puzzle.
    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.
    Default: "0.1.0"
    
    Specified by:
    
    getVersion in interface PomOptions
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: PomOptions
    
    (experimental) 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.
    Default: undefined
    
    Specified by:
    
    getDescription in interface PomOptions
  - getPackaging
```
public final String getPackaging()
```
    Description copied from interface: PomOptions
    
    (experimental) Project packaging format.
    Default: "jar"
    
    Specified by:
    
    getPackaging in interface PomOptions
  - getUrl
```
public final String getUrl()
```
    Description copied from interface: PomOptions
    
    (experimental) 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.
    Default: undefined
    
    Specified by:
    
    getUrl in interface PomOptions
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class JavaProjectOptions.Jsii$Proxy

Nested Class Summary

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

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.java.JavaProjectOptions

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getSample

getSampleJavaPackage

getCompileOptions

getDeps

getDistdir

getJunit

getJunitOptions

getPackagingOptions

getProjenrcJava

getProjenrcJavaOptions

getTestDeps

getAutoApproveOptions

getAutoMergeOptions

getClobber

getDevContainer

getGithub

getGithubOptions

getGitpod

getMergify

getMergifyOptions

getProjectType

getReadme

getStale

getStaleOptions

getVscode

getName

getLogging

getOutdir

getParent

getProjenCommand

getProjenrcJson

getProjenrcJsonOptions

getArtifactId

getGroupId

getVersion

getDescription

getPackaging

getUrl

$jsii$toJson

equals

hashCode