CoreExtension (ysf-core-plugin 1.0.0 API)

org.ysb33r.ysf.projects.core.extensions.CoreExtension

@groovy.transform.CompileStatic
class CoreExtension
extends Object

Project extension to use for all YSF project

Field Summary

Fields
Modifiers	Name	Description
`static String`	`DEFAULT_LICENSE_TYPE`
`static String`	`NAME`
`static String`	`SUBPATH_DEVELOPERS`

Properties Summary

Properties
Type	Name and description
`Provider<String>`	`licenseType`
`boolean`	`multiProject` Indicates that this project is part of a multi-project build.
`Provider<String>`	`projectCurrentYear`
`Provider<String>`	`projectInceptionYear`
`boolean`	`rootProject` Indicates that the current project is the root project.

Constructor Summary

Constructors
Constructor and description
`CoreExtension (Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
`<T>`	`static T`	`addCoreExtension(String name, Class<T> aClass, Project project, Object[] params)` Creates an extension on the core extension
`<T>`	`static T`	`findCoreExtension(Project project, Class<T> aClass)` Finds an extension on the core extension
	`static CoreExtension`	`findExtension(Project project)` Find this extension.
	`Provider<java.util.List<Person>>`	`getContributors()` A list of contributors to the project from `gradle/developers.yml`.
	`Provider<String>`	`getLicenseType()` The project license type.
	`Provider<java.util.List<Person>>`	`getMaintainers()` A list of project maintainers from `gradle/developers.yml`.
	`Provider<String>`	`getProjectCurrentYear()` The last year of the project.
	`Provider<String>`	`getProjectInceptionYear()` Returns the first year of the project.
	`Provider<String>`	`getProjectYearRange()` A formatted string showing the project years.
	`void`	`setLicenseType(Object type)` Set a SPDX license type.
	`void`	`setProjectCurrentYear(Object year)` Sets the current copyright year of the project.
	`void`	`setProjectInceptionYear(Object year)` Sets the project inception year.
	`void`	`setSnapshotCheckProvider(Provider<Boolean> check)` Allow a change to the provider of determines whether the project version is a SNAPSHOT.
	`Provider<Boolean>`	`snapshot()` A provider for determining whether the project version is a SNAPSHOT.
	`String`	`versionOf(String versionRef)` Finds a version in the version catalog.
	`String`	`versionOf(String catalog, String versionRef)` Finds a version in the version catalog.

Inherited Methods Summary

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

- Field Detail
  - public static final String DEFAULT_LICENSE_TYPE
  - public static final String NAME
  - public static final String SUBPATH_DEVELOPERS
- Property Detail
  - Provider<String> licenseType
  - final boolean multiProject
    
    Indicates that this project is part of a multi-project build.
    Returns:
    true is this is a multi-project build.
  - Provider<String> projectCurrentYear
  - Provider<String> projectInceptionYear
  - final boolean rootProject
    
    Indicates that the current project is the root project.
    Returns:
    true if tis is the root project.
- Constructor Detail
  - CoreExtension(Project project)
- Method Detail
  - <T> static T addCoreExtension(String name, Class<T> aClass, Project project, Object[] params)
    
    Creates an extension on the core extension
    Parameters:
    name - Name of the extension.
    aClass - Type of the extension.
    project - Contextual project
    params - Params to pass to extension's constructor.
    Returns:
    The newly created extension
  - <T> static T findCoreExtension(Project project, Class<T> aClass)
    
    Finds an extension on the core extension
    Parameters:
    project - Contextual project
    aClass - The type of the extension to find
    Returns:
    The extension.
  - static CoreExtension findExtension(Project project)
    
    Find this extension.
    Parameters:
    project - Contextual project
    Returns:
    The extension
  - Provider<java.util.List<Person>> getContributors()
    
    A list of contributors to the project from gradle/developers.yml.
    Returns:
    List of Gitlab identifiers.
  - Provider<String> getLicenseType()
    
    The project license type.
    Returns:
    License type provider.
  - Provider<java.util.List<Person>> getMaintainers()
    
    A list of project maintainers from gradle/developers.yml.
    Returns:
    List of Gitlab people
  - Provider<String> getProjectCurrentYear()
    
    The last year of the project.
    Returns:
    Project latest year
  - Provider<String> getProjectInceptionYear()
    
    Returns the first year of the project.
    Returns:
    Project start year
  - Provider<String> getProjectYearRange()
    
    A formatted string showing the project years.
    Returns:
    YEar ragne string provider
  - void setLicenseType(Object type)
    
    Set a SPDX license type.
    See https://spdx.org/licenses.
    
    If this value is not set, the a gradle property projectLicenseType will be used. If that is not available Apache 2.0 is assumed.
    
    Parameters:
    type - SPDX value
  - void setProjectCurrentYear(Object year)
    
    Sets the current copyright year of the project.
    If not set, it will take the current year.
    
    Parameters:
    year - Current year.
  - void setProjectInceptionYear(Object year)
    
    Sets the project inception year.
    If not set, it will look for a property called projectInceptionYear.
    
    Parameters:
    year - Inception year.
  - void setSnapshotCheckProvider(Provider<Boolean> check)
    
    Allow a change to the provider of determines whether the project version is a SNAPSHOT.
    Parameters:
    check - Provider that will return true is the project version is a snapshot.
  - Provider<Boolean> snapshot()
    
    A provider for determining whether the project version is a SNAPSHOT.
    Returns:
    Provider that will return true is the project is a snapshot.
  - String versionOf(String versionRef)
    
    Finds a version in the version catalog.
    Parameters:
    versionRef - Version reference
    Returns:
    Version
    Throws:
    GradleException if entry does not exist.
  - @SuppressWarnings(value: CatchException) String versionOf(String catalog, String versionRef)
    
    Finds a version in the version catalog.
    Parameters:
    catalog - Catalog name
    versionRef - Version reference
    Returns:
    Version
    Throws:
    GradleException if entry does not exist.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class CoreExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String DEFAULT_LICENSE_TYPE

public static final String NAME

public static final String SUBPATH_DEVELOPERS

Property Detail

Provider<String> licenseType

final boolean multiProject

Provider<String> projectCurrentYear

Provider<String> projectInceptionYear

final boolean rootProject

Constructor Detail

CoreExtension(Project project)

Method Detail

<T> static T addCoreExtension(String name, Class<T> aClass, Project project, Object[] params)

<T> static T findCoreExtension(Project project, Class<T> aClass)

static CoreExtension findExtension(Project project)

Provider<java.util.List<Person>> getContributors()

Provider<String> getLicenseType()

Provider<java.util.List<Person>> getMaintainers()

Provider<String> getProjectCurrentYear()

Provider<String> getProjectInceptionYear()

Provider<String> getProjectYearRange()

void setLicenseType(Object type)

void setProjectCurrentYear(Object year)

void setProjectInceptionYear(Object year)

void setSnapshotCheckProvider(Provider<Boolean> check)

Provider<Boolean> snapshot()

String versionOf(String versionRef)

@SuppressWarnings(value: CatchException) String versionOf(String catalog, String versionRef)