MavenPush (GradleMavenPush)

MavenPush

MavenPush Class - class with gradle properties getters, thread-safe and a fast singleton implementation.

Since:
1.5.0 Tokyo
Version:
1.6.0 Yokohama
Authors:
Alexander Savin

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`getAndroidJarArtifact()` Checks if Android jar artifact must be generated.
	`String`	`getAndroidJarMainClass()` Returns "Main-Class" attribute for Android's "var", "jar" and "fatjar" MANIFEST.MF files.
	`boolean`	`getApklibArtifact()` Checks if apklib artifact must be generated.
	`String`	`getCiSystem()` Returns continuous integration system.
	`String`	`getCiSystemUrl()` Returns continuous integration system url.
	`String[]`	`getContributors()` Returns array of contributors (name and email for each contributor).
	`String`	`getDeveloperEmail()` Returns developer email.
	`String`	`getDeveloperId()` Returns developer ID.
	`String`	`getDeveloperName()` Returns developer name.
	`String`	`getDeveloperOrg()` Returns developer organization.
	`String`	`getDeveloperOrgUrl()` Returns developer organization url.
	`String[]`	`getDeveloperRoles()` Returns array of developer roles.
	`String`	`getDeveloperTimezone()` Returns developer timezone.
	`String`	`getDeveloperUrl()` Returns developer url.
	`String[]`	`getDevelopers()` Returns array of developers (id, name and email for each developer).
	`String`	`getDistDownloadUrl()` Returns the url of the repository from whence another POM may point to in order to grab this POM's artifact.
	`boolean`	`getDoclintCheck()` Checks if doclint check on Javadoc generation must be enable.
	`String`	`getDokkaFatJarVersion()` Returns Dokka fatjar version
	`String`	`getDokkaOutputFormat()` Returns Dokka output format
	`boolean`	`getFatjarArtifact()` Checks if fatjar artifact must be generated.
	`String`	`getIssueSystem()` Returns issue tracking system.
	`String`	`getIssueSystemUrl()` Returns issue tracking system url.
	`String`	`getJavadocCharSet()` Returns Javadoc charset.
	`String`	`getJavadocDocEncoding()` Returns Javadoc doc encoding.
	`String`	`getJavadocEncoding()` Returns Javadoc encoding.
	`String[]`	`getMailingLists()` Returns array of mailing lists (name, subscribe email and unsubscribe email for each mailing list).
	`String`	`getOrg()` Returns organization.
	`String`	`getOrgUrl()` Returns organization url.
	`String`	`getPomArtifactId()` Returns Artifact ID.
	`String`	`getPomArtifactUrl()` Returns Artifact URL.
	`String`	`getPomDescription()` Returns library description.
	`String`	`getPomGroupId()` Returns Group ID.
	`String`	`getPomInceptionYear()` Returns inception year.
	`String`	`getPomLicenseComments()` Returns licence comments.
	`String`	`getPomLicenseDist()` Returns licence dist.
	`String`	`getPomLicenseName()` Returns licence name.
	`String`	`getPomLicenseUrl()` Returns licence url.
	`String`	`getPomName()` Returns library name.
	`String`	`getPomPackaging()` Returns packaging.
	`String`	`getPomScmConnection()` Returns connection element convey to how one is to connect to the version control system through Maven.
	`String`	`getPomScmDevConnection()` Returns connection element convey to how one is to connect to the version control system through Maven.
	`String`	`getPomScmTag()` Returns the tag that your project lives under.
	`String`	`getPomScmUrl()` Returns library publicly browsable repository url.
	`boolean`	`getPomUniqueVersion()` Checks if unique snapshots must be enable.
	`String`	`getPomUrl()` Returns library url.
	`String`	`getPomVersionName()` Returns version name.
	`String`	`getReleaseRepositoryUrl()` Returns release repository url.
	`String[]`	`getRepositories()` Returns array of repositories (id and url for each repository).
	`String`	`getRepositoryPassword()` Returns repository password (API Key for JCenter).
	`String`	`getRepositoryUsername()` Returns repository username.
	`String`	`getSnapshotRepositoryUrl()` Returns snapshot repository url.
	`boolean`	`getVarArtifact()` Checks if var artifact must be generated.
	`boolean`	`isDokka()` Checks if Dokka documentation engine must be used.
	`boolean`	`isHtml5()` Checks HTML version in the Javadoc comments.
	`boolean`	`isJCenter()` Checks if you're putting builds of your project on JCenter.
	`boolean`	`isReleaseBuild()` Checks if it's Release Build or SNAPSHOT Build of your project.
	`static MavenPush`	`with(def project)` Only method to get singleton object of MavenPush Class

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - boolean getAndroidJarArtifact()
    
    Checks if Android jar artifact must be generated.
    Returns:
    true if it's Android project and ANDROID_JAR_ARTIFACT gradle property value is "true", false otherwise
    See Also:
    getAndroidJarMainClass()
    getVarArtifact()
  - String getAndroidJarMainClass()
    
    Returns "Main-Class" attribute for Android's "var", "jar" and "fatjar" MANIFEST.MF files.
    Returns:
    ANDROID_JAR_MAIN_CLASS gradle property value or "" if project hasn't this property
  - boolean getApklibArtifact()
    
    Checks if apklib artifact must be generated.
    Returns:
    true if it's Android project and APKLIB_ARTIFACT gradle property value is "true", false otherwise
    See Also:
    getVarArtifact()
  - String getCiSystem()
    
    Returns continuous integration system.
    Returns:
    POM_CI_SYSTEM gradle property value or "" if project hasn't POM_CI_SYSTEM gradle property
  - String getCiSystemUrl()
    
    Returns continuous integration system url.
    Returns:
    POM_CI_SYSTEM_URL gradle property value or "" if project hasn't POM_CI_SYSTEM_URL gradle property
  - String[] getContributors()
    
    Returns array of contributors (name and email for each contributor). Example: ['Bill Gates' , 'bill@example.com' , 'Steve Jobs' , 'steve@example.com']
    Returns:
    contributors from POM_CONTRIBUTORS gradle property or [''] if project hasn't POM_CONTRIBUTORS gradle property
    See Also:
    getDevelopers()
  - String getDeveloperEmail()
    
    Returns developer email.
    Returns:
    POM_DEVELOPER_EMAIL gradle property value or "lazy-developer-who-does-not-read-readme@example.com" if project hasn't POM_DEVELOPER_EMAIL gradle property
    See Also:
    getDevelopers()
  - String getDeveloperId()
    
    Returns developer ID.
    throws:
    InvalidUserDataException If developer ID can't be return
    
    Returns:
    POM_DEVELOPER_ID gradle property value
    See Also:
    getDevelopers()
  - String getDeveloperName()
    
    Returns developer name.
    throws:
    InvalidUserDataException If developer name can't be return
    
    Returns:
    POM_DEVELOPER_NAME gradle property value
    See Also:
    getDevelopers()
  - String getDeveloperOrg()
    
    Returns developer organization.
    Returns:
    POM_DEVELOPER_ORG gradle property value or "" if project hasn't POM_DEVELOPER_ORG gradle property
    See Also:
    getOrg()
  - String getDeveloperOrgUrl()
    
    Returns developer organization url.
    Returns:
    POM_DEVELOPER_ORG_URL gradle property value or POM_ORG_URL gradle property value if project hasn't POM_DEVELOPER_ORG_URL gradle property or "" if project hasn't POM_DEVELOPER_ORG_URL gradle property and POM_ORG_URL gradle property
    See Also:
    getOrgUrl()
  - String[] getDeveloperRoles()
    
    Returns array of developer roles.
    Returns:
    developer roles from POM_DEVELOPER_ROLE gradle property and POM_DEVELOPER_ROLES gradle property or ['Software Developer'] if project hasn't POM_DEVELOPER_ROLE gradle property and POM_DEVELOPER_ROLES gradle property
  - String getDeveloperTimezone()
    
    Returns developer timezone.
    Returns:
    POM_DEVELOPER_TIMEZONE gradle property value or "" if project hasn't POM_DEVELOPER_TIMEZONE gradle property
  - String getDeveloperUrl()
    
    Returns developer url.
    Returns:
    POM_DEVELOPER_URL gradle property value or "" if project hasn't POM_DEVELOPER_URL gradle property
  - String[] getDevelopers()
    
    Returns array of developers (id, name and email for each developer). Example: [ ' B i l l G ' , 'Bill Gates' , 'bill@example.com' , 'SteveJ' , 'Steve Jobs' , 'steve@example.com']
    Returns:
    developers from POM_DEVELOPERS gradle property or [''] if project hasn't POM_DEVELOPERS gradle property
    See Also:
    getContributors()
  - String getDistDownloadUrl()
    
    Returns the url of the repository from whence another POM may point to in order to grab this POM's artifact.
    Returns:
    POM_DIST_DOWNLOAD_URL gradle property value or "" if project hasn't POM_DIST_DOWNLOAD_URL gradle property
  - boolean getDoclintCheck()
    
    Checks if doclint check on Javadoc generation must be enable.
    Returns:
    true if DOCLINT_CHECK gradle property value is "true", false otherwise
  - String getDokkaFatJarVersion()
    
    Returns Dokka fatjar version
    Returns:
    DOKKA_FATJAR_VERSION gradle property value or "0.9.17" if project hasn't this property
  - String getDokkaOutputFormat()
    
    Returns Dokka output format
    Returns:
    DOKKA_OUTPUT_FORMAT gradle property value or "javadoc" if project hasn't this property
  - boolean getFatjarArtifact()
    
    Checks if fatjar artifact must be generated.
    Returns:
    true if FATJAR_ARTIFACT gradle property value is "true", false otherwise
    See Also:
    getAndroidJarMainClass()
  - String getIssueSystem()
    
    Returns issue tracking system.
    Returns:
    POM_ISSUE_SYSTEM gradle property value or "" if project hasn't POM_ISSUE_SYSTEM gradle property
  - String getIssueSystemUrl()
    
    Returns issue tracking system url.
    Returns:
    POM_ISSUE_SYSTEM_URL gradle property value or "" if project hasn't POM_ISSUE_SYSTEM_URL gradle property
  - String getJavadocCharSet()
    
    Returns Javadoc charset.
    Returns:
    JAVADOC_CHARSET gradle property value or "UTF-8" if project hasn't this property
    See Also:
    getJavadocEncoding()
    getJavadocDocEncoding()
  - String getJavadocDocEncoding()
    
    Returns Javadoc doc encoding.
    Returns:
    JAVADOC_DOC_ENCODING gradle property value or "UTF-8" if project hasn't this property
    See Also:
    getJavadocEncoding()
    getJavadocCharSet()
  - String getJavadocEncoding()
    
    Returns Javadoc encoding.
    Returns:
    JAVADOC_ENCODING gradle property value or "UTF-8" if project hasn't this property
    See Also:
    getJavadocDocEncoding()
    getJavadocCharSet()
  - String[] getMailingLists()
    
    Returns array of mailing lists (name, subscribe email and unsubscribe email for each mailing list). Example: ['Main' , 's@example.com' , 'u@example.com' , 'Support' , 'ss@example.com' , 'us@example.com']
    Returns:
    mailing lists from POM_MAILING_LISTS gradle property or [''] if project hasn't POM_MAILING_LISTS gradle property
  - String getOrg()
    
    Returns organization.
    Returns:
    POM_ORG gradle property value or "" if project hasn't POM_ORG gradle property
  - String getOrgUrl()
    
    Returns organization url.
    Returns:
    POM_ORG_URL gradle property value or "" if project hasn't POM_ORG_URL gradle property
  - String getPomArtifactId()
    
    Returns Artifact ID.
    throws:
    InvalidUserDataException If Artifact ID can't be return
    
    Returns:
    POM_ARTIFACT_ID gradle property value
    See Also:
    getPomArtifactUrl()
  - String getPomArtifactUrl()
    
    Returns Artifact URL.
    throws:
    InvalidUserDataException If Artifact URL can't be return
    
    Returns:
    POM_ARTIFACT_URL gradle property value or POM_ARTIFACT_ID gradle property value if project hasn't this property
    See Also:
    getPomArtifactId()
  - String getPomDescription()
    
    Returns library description.
    throws:
    InvalidUserDataException If library description can't be return
    
    Returns:
    POM_DESCRIPTION gradle property value
  - String getPomGroupId()
    
    Returns Group ID.
    throws:
    InvalidUserDataException If Group ID can't be return.
    
    Returns:
    GROUP gradle property value or libraryVariants[0].applicationId value if project hasn't this property and it's Android project
  - String getPomInceptionYear()
    
    Returns inception year.
    Returns:
    POM_INCEPTION_YEAR gradle property value or "" if project hasn't POM_INCEPTION_YEAR gradle property
  - String getPomLicenseComments()
    
    Returns licence comments.
    Returns:
    POM_LICENCE_COMMENTS gradle property value or "" if project hasn't POM_LICENCE_COMMENTS gradle property
  - String getPomLicenseDist()
    
    Returns licence dist.
    Returns:
    POM_LICENCE_DIST gradle property value or "repo" if project hasn't POM_LICENCE_DIST gradle property
  - String getPomLicenseName()
    
    Returns licence name.
    throws:
    InvalidUserDataException If licence name can't be return
    
    Returns:
    POM_LICENCE_NAME gradle property value
  - String getPomLicenseUrl()
    
    Returns licence url.
    throws:
    InvalidUserDataException If licence url can't be return
    
    Returns:
    POM_LICENCE_URL gradle property value
  - String getPomName()
    
    Returns library name.
    throws:
    InvalidUserDataException If library name can't be return
    
    Returns:
    POM_NAME gradle property value
  - String getPomPackaging()
    
    Returns packaging.
    Returns:
    POM_PACKAGING gradle property value or "aar" for Android project and "jar" for non-Android project if project hasn't POM_PACKAGING gradle property
  - String getPomScmConnection()
    
    Returns connection element convey to how one is to connect to the version control system through Maven.
    throws:
    InvalidUserDataException If connection element can't be return
    
    Returns:
    POM_SCM_CONNECTION gradle property value
  - String getPomScmDevConnection()
    
    Returns connection element convey to how one is to connect to the version control system through Maven.
    throws:
    InvalidUserDataException If connection element can't be return
    
    Returns:
    POM_SCM_DEV_CONNECTION gradle property value or POM_SCM_CONNECTION gradle property value if project hasn't POM_SCM_DEV_CONNECTION gradle property
    See Also:
    getPomScmConnection()
  - String getPomScmTag()
    
    Returns the tag that your project lives under.
    Returns:
    POM_SCM_TAG gradle property value or "HEAD" (meaning, the Software Configuration Management (SCM) root) if project hasn't POM_SCM_TAG gradle property
  - String getPomScmUrl()
    
    Returns library publicly browsable repository url.
    throws:
    InvalidUserDataException If library publicly browsable repository url can't be return
    
    Returns:
    POM_SCM_URL gradle property value or POM_URL gradle property value if project hasn't POM_SCM_URL gradle property
    See Also:
    getPomUrl()
  - boolean getPomUniqueVersion()
    
    Checks if unique snapshots must be enable.
    Returns:
    true if POM_GENERATE_UNIQUE_SNAPSHOTS gradle property value is "true" or if project hasn't POM_GENERATE_UNIQUE_SNAPSHOTS gradle property, false otherwise
  - String getPomUrl()
    
    Returns library url.
    throws:
    InvalidUserDataException If library url can't be return
    
    Returns:
    POM_URL gradle property value
  - String getPomVersionName()
    
    Returns version name.
    throws:
    InvalidUserDataException If version name can't be return
    
    Returns:
    VERSION_NAME gradle property value + VERSION_NAME_EXTRAS environment variable value or defaultConfig.versionName value + VERSION_NAME_EXTRAS environment variable value if project hasn't VERSION_NAME gradle property and it's Android project
  - String getReleaseRepositoryUrl()
    
    Returns release repository url.
    Returns:
    RELEASE_REPOSITORY_URL gradle property value or "https://bintray.com/api/v1/maven/{project.NEXUS_USERNAME}/maven/{project.POM_ARTIFACT_ID}/;publish=1" for JCenter and "https://oss.sonatype.org/service/local/staging/deploy/maven2/" for Maven Central if project hasn't this property
    See Also:
    getSnapshotRepositoryUrl()
  - String[] getRepositories()
    
    Returns array of repositories (id and url for each repository). Example: ['mavenCentral' , 'https://repo1.maven.org/maven2/' , 'jCenter' , 'https://jcenter.bintray.com/']
    Returns:
    repositories from POM_REPOSITORIES gradle property or [''] if project hasn't POM_REPOSITORIES gradle property if release build; repositories from POM_SNAPSHOT_REPOSITORIES gradle property or repositories from POM_REPOSITORIES gradle property if project hasn't POM_SNAPSHOT_REPOSITORIES gradle property or [''] if project hasn't POM_SNAPSHOT_REPOSITORIES and POM_REPOSITORIES gradle properties if non-release build
  - String getRepositoryPassword()
    
    Returns repository password (API Key for JCenter).
    Returns:
    if IS_JCENTER gradle property value equals "true" returns JCENTER_API_KEY system environment variable or JCENTER_API_KEY gradle property value if System hasn't this environment variable, returns NEXUS_PASSWORD environment variable value or NEXUS_PASSWORD gradle property value if System hasn't this environment variable or "" if System hasn't this environment variable and project hasn't this property
    See Also:
    getRepositoryUsername()
  - String getRepositoryUsername()
    
    Returns repository username.
    Returns:
    if IS_JCENTER gradle property value equals "true" returns JCENTER_USERNAME system environment variable or JCENTER_USERNAME gradle property value if System hasn't this environment variable, returns NEXUS_USERNAME environment variable value or NEXUS_USERNAME gradle property value if System hasn't this environment variable or "" if System hasn't this environment variable and project hasn't this property
    See Also:
    getRepositoryPassword()
  - String getSnapshotRepositoryUrl()
    
    Returns snapshot repository url.
    Returns:
    SNAPSHOT_REPOSITORY_URL gradle property value or "https://oss.jfrog.org/artifactory/oss-snapshot-local/" for JCenter and "https://oss.sonatype.org/content/repositories/snapshots/" for Maven Central if project hasn't this property
    See Also:
    getReleaseRepositoryUrl()
  - boolean getVarArtifact()
    
    Checks if var artifact must be generated.
    Returns:
    true if it's Android project and VAR_ARTIFACT gradle property value is "true" or project hasn't this property, false otherwise
    See Also:
    getAndroidJarMainClass()
  - boolean isDokka()
    
    Checks if Dokka documentation engine must be used.
    Returns:
    true if JAVADOC_BY_DOKKA gradle property value is "true", false otherwise
  - boolean isHtml5()
    
    Checks HTML version in the Javadoc comments.
    Returns:
    true if JAVADOC_HTML_VERSION gradle property value is "5", false otherwise
  - boolean isJCenter()
    
    Checks if you're putting builds of your project on JCenter.
    Returns:
    true if JCenter, false otherwise
  - boolean isReleaseBuild()
    
    Checks if it's Release Build or SNAPSHOT Build of your project.
    Returns:
    true if Release Build, false otherwise
  - static MavenPush with(def project)
    
    Only method to get singleton object of MavenPush Class
    Parameters:
    project - project
    Returns:
    thread-safe singleton

Summary:
Method

| Detail:
Method

GradleMavenPush

[Groovy] Class MavenPush

Methods Summary

Inherited Methods Summary

Method Detail

boolean getAndroidJarArtifact()

String getAndroidJarMainClass()

boolean getApklibArtifact()

String getCiSystem()

String getCiSystemUrl()

String[] getContributors()

String getDeveloperEmail()

String getDeveloperId()

String getDeveloperName()

String getDeveloperOrg()

String getDeveloperOrgUrl()

String[] getDeveloperRoles()

String getDeveloperTimezone()

String getDeveloperUrl()

String[] getDevelopers()

String getDistDownloadUrl()

boolean getDoclintCheck()

String getDokkaFatJarVersion()

String getDokkaOutputFormat()

boolean getFatjarArtifact()

String getIssueSystem()

String getIssueSystemUrl()

String getJavadocCharSet()

String getJavadocDocEncoding()

String getJavadocEncoding()

String[] getMailingLists()

String getOrg()

String getOrgUrl()

String getPomArtifactId()

String getPomArtifactUrl()

String getPomDescription()

String getPomGroupId()

String getPomInceptionYear()

String getPomLicenseComments()

String getPomLicenseDist()

String getPomLicenseName()

String getPomLicenseUrl()

String getPomName()

String getPomPackaging()

String getPomScmConnection()

String getPomScmDevConnection()

String getPomScmTag()

String getPomScmUrl()

boolean getPomUniqueVersion()

String getPomUrl()

String getPomVersionName()

String getReleaseRepositoryUrl()

String[] getRepositories()

String getRepositoryPassword()

String getRepositoryUsername()

String getSnapshotRepositoryUrl()

boolean getVarArtifact()

boolean isDokka()

boolean isHtml5()

boolean isJCenter()

boolean isReleaseBuild()

static MavenPush with(def project)