JvmCoreExtension (ysf-core-plugin 0.1.0 API)

Summary:
Field
Property
Constructor
Method

org.ysb33r.ysf.projects.core.extensions.JvmCoreExtension

@groovy.transform.CompileStatic
class JvmCoreExtension
extends Object

An extension for configuring JVM-based development.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`NAME`

Properties Summary

Properties
Type	Name and description
`Object`	`artifactDescription`

Constructor Summary

Constructors
Constructor and description
`JvmCoreExtension (Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exposeJavaPackagesInDocs(String[] packages)` Add packages which should be exposed in GroovyDoc.
	`Provider<String>`	`getArtifactDescription()` Description of the main artifact produced by this project.
	`Provider<java.util.List<String>>`	`getJavaPackagesInDocs()` List of packages for which links can be created in docs.
	`void`	`javaLanguageVersion(int ver)` Set the language toolchain to use.
	`void`	`javaLanguageVersion(String ver)` Set the language toolchain to use.
	`void`	`setArtifactDescription(Object text)` Sets a description for the artifact.

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 NAME
- Property Detail
  - Object artifactDescription
- Constructor Detail
  - JvmCoreExtension(Project project)
- Method Detail
  - void exposeJavaPackagesInDocs(String[] packages)
    
    Add packages which should be exposed in GroovyDoc.
    These are packages above and beyond java.lang, java.io and java.net.
    
    Parameters:
    packages - List of packages.
  - Provider<String> getArtifactDescription()
    
    Description of the main artifact produced by this project.
    Returns:
    Description.
  - Provider<java.util.List<String>> getJavaPackagesInDocs()
    
    List of packages for which links can be created in docs.
    Returns:
    List of packages.
  - void javaLanguageVersion(int ver)
    
    Set the language toolchain to use.
    Parameters:
    ver - Version
  - void javaLanguageVersion(String ver)
    
    Set the language toolchain to use.
    Parameters:
    ver - Version
  - void setArtifactDescription(Object text)
    
    Sets a description for the artifact. If not set, will try to read Project.getDescription.
    Parameters:
    test - Description of the main artifact.

Summary:
Field
Property
Constructor
Method

Groovy Documentation