Package io.github.cdklabs.projen.java

Class PomOptions.Jsii$Proxy

  • All Implemented Interfaces:
    PomOptions, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    PomOptions
    @Stability(Experimental)
@Internal
public static final class PomOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements PomOptions
    An implementation for PomOptions

    • Nested Class Summary

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

        software.amazon.jsii.JsiiObject.InitializationMode

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Jsii$Proxy​(PomOptions.Builder builder)
      Constructor that initializes the object based on literal property values passed by the PomOptions.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 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.
      String getDescription()
      (experimental) Description of a project is always good.
      String getGroupId()
      (experimental) This is generally unique amongst an organization or a project.
      String getPackaging()
      (experimental) Project packaging format.
      ParentPom getParentPom()
      (experimental) A Parent Pom can be used to have a child project inherit properties/plugins/ect in order to reduce duplication and keep standards across a large amount of repos.
      String getUrl()
      (experimental) The URL, like the name, is not required.
      String getVersion()
      (experimental) This is the last piece of the naming puzzle.
      int hashCode()  

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

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

    • Method Detail

      • 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

      • getParentPom

        public final ParentPom getParentPom()
        Description copied from interface: PomOptions
        (experimental) A Parent Pom can be used to have a child project inherit properties/plugins/ect in order to reduce duplication and keep standards across a large amount of repos.

        Default: undefined

        Specified by:
        getParentPom 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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object