org.myire.quill.jol

Class JolTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.myire.quill.jol.JolTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>, ReportingEntity<JolReports>

public class JolTask
extends org.gradle.api.DefaultTask
implements ReportingEntity<JolReports>

Task for object layout analysis using the Jol tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JolTask.ClassesDirectory Specification of a directory containing class files with an optional PatternFilterable specifying which files to include and/or exclude.

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
JolTask()

Method Summary

Modifier and Type	Method and Description
void	classesDirectory(java.lang.Object pDirectoryPath) Add a directory containing classes to analyze.
void	classesDirectory(java.lang.Object pDirectoryPath, groovy.lang.Closure<?> pFilterClosure) Add a directory containing classes to analyze.
int	getAlignment() Get the alignment parameter for the Jol analysis.
org.gradle.api.file.FileCollection	getAnalysisClassPath() Get the class path from which to load any classes referenced by the classes to analyze.
java.util.Collection<java.lang.String>	getClasses() Get the fully qualified names of classes to analyze.
java.util.Collection<java.io.File>	getClassesDirectories() Get the directories containing class files to analyze.
JolParameters.DataModel	getDataModel() Get the data model parameter for the Jol analysis.
JolParameters.Layout	getLayout() Get the layout parameter for the Jol analysis.
JolReports	getReports() Get the reports produced by this task.
org.gradle.api.file.FileCollection	getToolClassPath() Get the class path from which to load the Jol classes.
java.lang.String	getToolVersion() Get the version of Jol to use.
JolReports	reports(org.gradle.api.Action<? super JolReports> pAction) Configure this task's reports.
JolReports	reports(groovy.lang.Closure pClosure) Configure this task's reports.
void	run() Analyze the layout of the specified classes and produce the enabled report(s).
void	setAlignment(int pAlignment)
void	setAnalysisClassPath(java.lang.Object pAnalysisClassPath)
void	setClasses(java.util.Collection<java.lang.String> pClasses)
void	setClasses(java.lang.String... pClasses)
void	setDataModel(JolParameters.DataModel pDataModel)
void	setLayout(JolParameters.Layout pLayout)
void	setToolClassPath(org.gradle.api.file.FileCollection pToolClassPath)
void	setToolVersion(java.lang.String pToolVersion)
void	sourceSet(org.gradle.api.tasks.SourceSet pSourceSet) Specify a source set to analyze classes from.
void	sourceSet(org.gradle.api.tasks.SourceSet pSourceSet, groovy.lang.Closure<?> pFilterClosure) Specify a source set to analyze classes from.

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

JolTask

public JolTask()

Method Detail

getLayout

@Input
public JolParameters.Layout getLayout()

Get the layout parameter for the Jol analysis. Default is JolParameters.Layout.HOTSPOT.

Returns:

The layout parameter.

setLayout

public void setLayout(JolParameters.Layout pLayout)

getDataModel

@Input
public JolParameters.DataModel getDataModel()

Get the data model parameter for the Jol analysis. Default is JolParameters.DataModel.x86_64_COMPRESSED.

Returns:

The data model parameter.

setDataModel

public void setDataModel(JolParameters.DataModel pDataModel)

getAlignment

@Input
public int getAlignment()

Get the alignment parameter for the Jol analysis. Default is 8.

Returns:

The alignment parameter.

setAlignment

public void setAlignment(int pAlignment)

getToolVersion

@Input
public java.lang.String getToolVersion()

Get the version of Jol to use. Default is "0.10".

Returns:

The Jol version string.

setToolVersion

public void setToolVersion(java.lang.String pToolVersion)

getClasses

@Input
public java.util.Collection<java.lang.String> getClasses()

Get the fully qualified names of classes to analyze.

Returns:

The classes to analyze, never null.

setClasses

public void setClasses(java.util.Collection<java.lang.String> pClasses)

setClasses

public void setClasses(java.lang.String... pClasses)

getAnalysisClassPath

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

Get the class path from which to load any classes referenced by the classes to analyze. The classes in the returned collection will not be analyzed but are required when loading the classes to analyze.

Returns:

The analysis class path, never null.

setAnalysisClassPath

public void setAnalysisClassPath(java.lang.Object pAnalysisClassPath)

getToolClassPath

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

Get the class path from which to load the Jol classes.

Returns:

The tool class path.

setToolClassPath

public void setToolClassPath(org.gradle.api.file.FileCollection pToolClassPath)

getClassesDirectories

@InputFiles
public java.util.Collection<java.io.File> getClassesDirectories()

Get the directories containing class files to analyze.

Returns:

The class file directories, never null.

classesDirectory

public void classesDirectory(java.lang.Object pDirectoryPath)

Add a directory containing classes to analyze.

Parameters:

pDirectoryPath - An object that resolves to a directory. See the documentation of org.gradle.api.Project::file() for the possible types that can be resolved.

Throws:

java.lang.NullPointerException - if pDirectoryPath is null.

classesDirectory

public void classesDirectory(java.lang.Object pDirectoryPath,
                             groovy.lang.Closure<?> pFilterClosure)

Add a directory containing classes to analyze. The class files in the directory can be filtered through a Closure that configures a PatternFilterable.

Parameters:

pDirectoryPath - An object that resolves to a directory. See the documentation of org.gradle.api.Project::file() for the possible types that can be resolved.

pFilterClosure - A closure that configures a PatternFilterable. Pass null to include all class files in the directory.

Throws:

java.lang.NullPointerException - if pDirectoryPath is null.

sourceSet

public void sourceSet(org.gradle.api.tasks.SourceSet pSourceSet)

Specify a source set to analyze classes from. The source set's classes directories will be added to the classes directories and the source set's runtime class path will be added to the analysis class path.

By default this task analyzes the main source set, if available.

Parameters:

pSourceSet - The source set.

Throws:

java.lang.NullPointerException - if pSourceSet is null.

sourceSet

public void sourceSet(org.gradle.api.tasks.SourceSet pSourceSet,
                      groovy.lang.Closure<?> pFilterClosure)

Specify a source set to analyze classes from. The source set's classes directories will be added to the classes directories and the source set's runtime class path will be added to the analysis class path. The class files in the classes directories can be filtered through a Closure that configures a PatternFilterable.

By default this task analyzes the main source set, if available.

Parameters:

pSourceSet - The source set.

pFilterClosure - A closure that configures a PatternFilterable. Pass null to include all class files in the source set's classes directories.

Throws:

java.lang.NullPointerException - if pSourceSet is null.

getReports

public JolReports getReports()

Get the reports produced by this task.

Specified by:

getReports in interface ReportingEntity<JolReports>

Returns:

The reports.

reports

public JolReports reports(groovy.lang.Closure pClosure)

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<JolReports>

Parameters:

pClosure - A closure that configures the reports.

Returns:

This task's reports.

reports

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

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<JolReports>

Parameters:

pAction - An action that configures the reports.

Returns:

This task's reports.

Throws:

java.lang.NullPointerException - if pAction is null.

run

public void run()

Analyze the layout of the specified classes and produce the enabled report(s).