io.github.cdklabs.projen.java

Interface PomOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsCdkJavaAppOptions, JavaProjectCommonOptions, JavaProjectOptions

All Known Implementing Classes:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.827Z")
 @Stability(value=Experimental)
public interface PomOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for `Pom`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static PomOptions.Builder	builder()
String	getArtifactId() (experimental) The artifactId is generally the name that the project is known by.
default String	getDescription() (experimental) Description of a project is always good.
String	getGroupId() (experimental) This is generally unique amongst an organization or a project.
default String	getPackaging() (experimental) Project packaging format.
default String	getUrl() (experimental) The URL, like the name, is not required.
String	getVersion() (experimental) This is the last piece of the naming puzzle.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifactId

@Stability(value=Experimental)
 @NotNull
String getArtifactId()

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

getGroupId

@Stability(value=Experimental)
 @NotNull
String getGroupId()

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

getVersion

@Stability(value=Experimental)
 @NotNull
String getVersion()

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

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(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

getPackaging

@Stability(value=Experimental)
 @Nullable
default String getPackaging()

(experimental) Project packaging format.

Default: "jar"

getUrl

@Stability(value=Experimental)
 @Nullable
default String getUrl()

(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

builder

@Stability(value=Experimental)
static PomOptions.Builder builder()

Returns:

a PomOptions.Builder of PomOptions