org.myire.quill.scent

Class ScentTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

org.myire.quill.scent.ScentTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>, ReportingEntity<ScentReports>

public class ScentTask
extends org.gradle.api.tasks.SourceTask
implements ReportingEntity<ScentReports>

Task for creating source code metrics reports using the Scent library.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
ScentTask()

Method Summary

Modifier and Type	Method and Description
int	getLanguageLevel() The language level to parse the sources with.
ScentReports	getReports() Get the reports produced by this task.
org.gradle.api.file.FileCollection	getScentClasspath() Get the classpath containing the Scent classes used by the task.
org.gradle.api.file.FileTree	getSource() Get the source files to collect metrics from.
java.lang.String	getSourceEncoding() Get the encoding of the Java source files.
java.lang.String	getToolVersion() Get the version of Scent to use.
boolean	isEnableLanguagePreviews() If true, the language feature previews of the language level specified by setLanguageLevel(int) will be enabled.
ScentReports	reports(org.gradle.api.Action<? super ScentReports> pAction) Configure this task's reports.
ScentReports	reports(groovy.lang.Closure pClosure) Configure this task's reports.
void	run() Calculate code metrics for the sources and produce the enabled report(s).
void	setEnableLanguagePreviews(boolean pEnableLanguagePreviews)
void	setLanguageLevel(int pLanguageLevel)
void	setScentClasspath(org.gradle.api.file.FileCollection pScentClasspath)
void	setSourceEncoding(java.lang.String pSourceEncoding)
void	setToolVersion(java.lang.String pToolVersion)

Methods inherited from class org.gradle.api.tasks.SourceTask

exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString, usesService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScentTask

public ScentTask()

Method Detail

getToolVersion

@Input
public java.lang.String getToolVersion()

Get the version of Scent to use. Default is "2.0".

Returns:

The Scent version string.

setToolVersion

public void setToolVersion(java.lang.String pToolVersion)

getSourceEncoding

@Input
 @Optional
public java.lang.String getSourceEncoding()

Get the encoding of the Java source files. The platform's default encoding will be used if this property isn't specified.

Returns:

The source file encoding.

setSourceEncoding

public void setSourceEncoding(java.lang.String pSourceEncoding)

getLanguageLevel

@Input
public int getLanguageLevel()

The language level to parse the sources with. A value of 0 means the default version.

Returns:

The language level.

setLanguageLevel

public void setLanguageLevel(int pLanguageLevel)

isEnableLanguagePreviews

@Input
public boolean isEnableLanguagePreviews()

If true, the language feature previews of the language level specified by setLanguageLevel(int) will be enabled. Default is false, i.e. language feature previews will be disabled when parsing the sources.

Returns:

True if language feature previews should be enabled, false if they should be disabled.

setEnableLanguagePreviews

public void setEnableLanguagePreviews(boolean pEnableLanguagePreviews)

getScentClasspath

@InputFiles
public org.gradle.api.file.FileCollection getScentClasspath()

Get the classpath containing the Scent classes used by the task. The plugin sets this property to its default value, which is the scent configuration.

Returns:

The Scent classpath.

setScentClasspath

public void setScentClasspath(org.gradle.api.file.FileCollection pScentClasspath)

getSource

@InputFiles
 @SkipWhenEmpty
public org.gradle.api.file.FileTree getSource()

Get the source files to collect metrics from. Default is the main source set's Java files.

Overrides:

getSource in class org.gradle.api.tasks.SourceTask

Returns:

The source files.

getReports

public ScentReports getReports()

Get the reports produced by this task.

Specified by:

getReports in interface ReportingEntity<ScentReports>

Returns:

The reports.

reports

public ScentReports reports(groovy.lang.Closure pClosure)

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<ScentReports>

Parameters:

pClosure - A closure that configures the reports.

Returns:

This task's reports.

reports

public ScentReports reports(org.gradle.api.Action<? super ScentReports> pAction)

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<ScentReports>

Parameters:

pAction - An action that configures the reports.

Returns:

This task's reports.

run

public void run()

Calculate code metrics for the sources and produce the enabled report(s).