gradle-defaults / com.mooregreatsoftware.gradle.defaults / DefaultsExtension

DefaultsExtension

open class DefaultsExtension : ReadableDefaultsExtension

Configuration for DefaultsPlugin.

See Also

defaultsExtension

Constructors

<init> DefaultsExtension(project: Project, license: ExtLicenseExtension, lombok: LombokExtension, checkerFramework: CheckerFrameworkExtension)

Configuration for DefaultsPlugin.

Properties

bintrayLabels open var bintrayLabels: Set<String>?

The labels to set of the BinTray package, if BinTray is used.

bintrayPkg open var bintrayPkg: String?

The name of the BinTray package name, if BinTray is used.

bintrayRepo open var bintrayRepo: String?

The name of the BinTray repository to upload artifacts to, if BinTray is used.

checkerFramework open val checkerFramework: CheckerFrameworkExtension

Configuration for Checker Framework

compatibilityVersion open val compatibilityVersion: JavaVersion

The version of the Java Virtual Machine to target. Used for all the compilers that target the JVM. Defaults to the version of Java being used to run Gradle and compile the code.

contributors open var contributors: Set<Map<*, *>>?

The information to add to the "contributors" section of the Maven pom.xml

copyrightYears open var copyrightYears: String

The copyright years for the project. Used for injecting into the license headers under the key "year". Defaults to the current year.

developers open val developers: Set<Developer>?

The information to add to the "developers" section of the Maven pom.xml

isBintrayToCentral open var isBintrayToCentral: Boolean

Should the artifacts upload to BinTray also be sent to Maven Central?

issuesUrl open var issuesUrl: String

The URL for where to find issue reports for the project. Defaults to "$siteUrl/issues"

license open val license: ExtLicenseExtension

Configuration for the license plugin

licenseKey open var licenseKey: String

The "key" for the license. Used by BinTray. Defaults to "Apache-2.0"

licenseName open var licenseName: String

The name of the license. Used by Maven. Defaults to "The Apache Software License, Version 2.0"

licenseUrl open var licenseUrl: String

The URL of the license. Used by Maven. Defaults to http://www.apache.org/licenses/LICENSE-2.0

lombok open val lombok: LombokExtension

Configuration for Lombok

openSource open var openSource: Boolean

Is this an open-source project? If true, additional assumptions are made, such as the need to have a license on all code.

orgId open var orgId: String

The id of the organization (a user also counts as a one-person organization). Used as the default for computing the default values of siteUrl, vcsReadUrl and vcsWriteUrl.

orgName open var orgName: String?

Used for configuring BinTray and Maven metadata.

orgUrl open var orgUrl: String?

If there's an orgName then this is used as part of the "organization" section of the Maven pom.xml

project open val project: Project

The Project this is associated/registered with.

siteUrl open var siteUrl: String

The URL for the project. Defaults to "https://github.com/$orgId/${project.name}"

vcsReadUrl open var vcsReadUrl: String

The URL for where the version control system gets the source code for the project. Defaults to "${siteUrl}.git"

vcsWriteUrl open var vcsWriteUrl: String

The URL for where the version control system gets the source code for the project. Defaults to vcsReadUrl

Functions

inspect fun inspect(): String
setCompatibilityVersion fun setCompatibilityVersion(compatibilityVersion: Any): Unit
setDevelopers fun setDevelopers(devs: Set<Map<String, Any>>): Unit
setId fun setId(value: String): Unit
toString open fun toString(): String

Companion Object Properties

LOG val LOG: Logger
NAME const val NAME: String

The name to register this under as a Gradle extension.

VCS_WRITE_URL_KEY const val VCS_WRITE_URL_KEY: String