com.brambolt.gradle.pathing.tasks

Class PathingJar

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.AbstractCopyTask

org.gradle.api.tasks.bundling.AbstractArchiveTask

org.gradle.api.tasks.bundling.Zip

org.gradle.jvm.tasks.Jar

org.gradle.api.tasks.bundling.Jar

com.brambolt.gradle.pathing.tasks.PathingJar

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.file.ContentFilterable, org.gradle.api.file.CopyProcessingSpec, org.gradle.api.file.CopySourceSpec, org.gradle.api.file.CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, 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>

public class PathingJar
extends org.gradle.api.tasks.bundling.Jar

This class supports the creation of pathing jars given configurations to form the class path and a main class to execute.

Nested Class Summary

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

org.gradle.api.Task.Namer

Field Summary

Fields inherited from class org.gradle.jvm.tasks.Jar

DEFAULT_EXTENSION

Fields inherited from class org.gradle.api.tasks.bundling.Zip

ZIP_EXTENSION

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

Method Summary

Modifier and Type	Method and Description
org.gradle.api.Task	configure(groovy.lang.Closure closure) Configures the pathing jar task.
org.gradle.api.file.FileCollection	createClassPath(java.util.List<org.gradle.api.artifacts.Configuration> included) Combines the parameter configurations into a single class path.
java.lang.String	formatClassPath() Combines the included configurations into a single class path.
java.util.Map<java.lang.String,java.lang.String>	generateAttributes() Generate the pathing attributes, including Class-Path and Main-Class.
java.util.Map<java.lang.String,java.lang.String>	getAttributeValues() Getter.
java.util.List<org.gradle.api.artifacts.Configuration>	getIncludedConfigurations() Getter.
org.gradle.api.file.FileCollection	getIncludedFiles() Getter.
java.lang.String	getMainClass() Getter.
boolean	isAllPermissions() Getter.
void	setAllPermissions(boolean allPermissions) Getter.
void	setAttributeValues(java.util.Map<java.lang.String,java.lang.String> attributeValues) Setter.
void	setIncludedConfigurations(java.util.List<org.gradle.api.artifacts.Configuration> includedConfigurations) Setter.
void	setIncludedFiles(org.gradle.api.file.FileCollection includedFiles) Setter.
void	setMainClass(java.lang.String mainClass) Setter.

Methods inherited from class org.gradle.api.tasks.bundling.Jar

manifest

Methods inherited from class org.gradle.jvm.tasks.Jar

getManifest, getManifestContentCharset, getMetadataCharset, getMetaInf, manifest, metaInf, metaInf, setManifest, setManifestContentCharset, setMetadataCharset

Methods inherited from class org.gradle.api.tasks.bundling.Zip

createCopyAction, getCompressor, getEntryCompression, isZip64, setEntryCompression, setZip64

Methods inherited from class org.gradle.api.tasks.bundling.AbstractArchiveTask

createCopyActionExecuter, getAppendix, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchiveName, getArchivePath, getArchiveVersion, getBaseName, getClassifier, getDestinationDir, getDestinationDirectory, getExtension, getVersion, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setAppendix, setArchiveName, setBaseName, setClassifier, setDestinationDir, setExtension, setPreserveFileTimestamps, setReproducibleFileOrder, setVersion

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

copy, createRootSpec, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getObjectFactory, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

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

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.DefaultTask

compareTo, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Constructor Detail

PathingJar

public PathingJar()

Method Detail

getIncludedConfigurations

public java.util.List<org.gradle.api.artifacts.Configuration> getIncludedConfigurations()

Getter.

Returns:

The included configurations.

setIncludedConfigurations

public void setIncludedConfigurations(java.util.List<org.gradle.api.artifacts.Configuration> includedConfigurations)

Setter.

Parameters:

includedConfigurations - The configurations to include on the class path.

getIncludedFiles

public org.gradle.api.file.FileCollection getIncludedFiles()

Getter.

Returns:

The included files.

setIncludedFiles

public void setIncludedFiles(org.gradle.api.file.FileCollection includedFiles)

Setter.

Parameters:

includedFiles - The files to include.

getMainClass

public java.lang.String getMainClass()

Getter.

Returns:

The main class to be used.

setMainClass

public void setMainClass(java.lang.String mainClass)

Setter.

Parameters:

mainClass - The main class to use.

isAllPermissions

public boolean isAllPermissions()

Getter.

Returns:

The all-permissions flag.

setAllPermissions

public void setAllPermissions(boolean allPermissions)

Getter.

Parameters:

allPermissions - The all-permissions flag to set.

getAttributeValues

public java.util.Map<java.lang.String,java.lang.String> getAttributeValues()

Getter.

Returns:

The manifest attribute values to apply.

setAttributeValues

public void setAttributeValues(java.util.Map<java.lang.String,java.lang.String> attributeValues)

Setter.

Parameters:

attributeValues - The manifest attribute values to use.

configure

@CompileStatic
public org.gradle.api.Task configure(groovy.lang.Closure closure)

Configures the pathing jar task.

The manifest attributes are not computed until execution, to avoid resolving the included configurations during the configuration phase.

Specified by:

configure in interface org.gradle.api.Task

Specified by:

configure in interface org.gradle.util.Configurable<org.gradle.api.Task>

Overrides:

configure in class org.gradle.api.DefaultTask

Parameters:

closure - The configuration closure for the task

Returns:

The configured task

generateAttributes

public java.util.Map<java.lang.String,java.lang.String> generateAttributes()

Generate the pathing attributes, including Class-Path and Main-Class.

Returns:

The attribute-value assignments to be included in the manifest

createClassPath

public org.gradle.api.file.FileCollection createClassPath(java.util.List<org.gradle.api.artifacts.Configuration> included)

Combines the parameter configurations into a single class path.

Parameters:

included - The configurations to form a class path from

Returns:

A file collection comprising the combined class path

formatClassPath

public java.lang.String formatClassPath()

Combines the included configurations into a single class path.

Returns:

A class path string to include in the pathing jar