org.myire.quill.ivy

Class IvyFileConvertTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.myire.quill.ivy.IvyFileConvertTask

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>

public class IvyFileConvertTask
extends org.gradle.api.DefaultTask

A task that imports configurations and/or dependencies from an Ivy file and writes them to an output file on Gradle notation.

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_GROUP, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
IvyFileConvertTask()

Method Summary

Modifier and Type	Method and Description
void	convertIvyFile() Import configurations and/or dependencies from the Ivy file specified in the ivyFile property and write them on Gradle notation to the file specified in the destination property.
java.io.File	getDestination() Get the specification for the destination file to create.
java.io.File	getIvyFile() Get the specification for the Ivy file to import from.
boolean	isConvertConfigurations() Should the configurations from the Ivy file be imported and converted? Default is true.
boolean	isConvertDependencies() Should the dependencies from the Ivy file be imported and converted? Default is true.
boolean	isOverwrite() Should the destination file be overwritten if it exists? If this property is false and the destination file exists, the task will do nothing.
void	setConvertConfigurations(boolean pConvertConfigurations)
void	setConvertDependencies(boolean pConvertDependencies)
void	setDestination(java.lang.Object pPath) Set the path of the destination file to create.
void	setIvyFile(java.lang.Object pPath) Set the path of the Ivy file to import from.
void	setOverwrite(boolean pOverwrite)

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

IvyFileConvertTask

public IvyFileConvertTask()

Method Detail

isConvertConfigurations

@Input
public boolean isConvertConfigurations()

Should the configurations from the Ivy file be imported and converted? Default is true.

Returns:

True if configurations should be imported and converted, false if not.

setConvertConfigurations

public void setConvertConfigurations(boolean pConvertConfigurations)

isConvertDependencies

@Input
public boolean isConvertDependencies()

Should the dependencies from the Ivy file be imported and converted? Default is true.

Returns:

True if dependencies should be imported and converted, false if not.

setConvertDependencies

public void setConvertDependencies(boolean pConvertDependencies)

isOverwrite

@Input
public boolean isOverwrite()

Should the destination file be overwritten if it exists? If this property is false and the destination file exists, the task will do nothing. Default is true.

Returns:

True if the destination file should be overwritten, false if not.

setOverwrite

public void setOverwrite(boolean pOverwrite)

getIvyFile

@InputFile
public java.io.File getIvyFile()

Get the specification for the Ivy file to import from. The default value is a file named "ivy.xml" in the project directory.

Returns:

The Ivy file specification.

setIvyFile

public void setIvyFile(java.lang.Object pPath)

Set the path of the Ivy file to import from. The specified path will be resolved relative to the project directory.

Parameters:

pPath - The Ivy file path. Passing null will cause the default value to be returned from getIvyFile.

getDestination

@OutputFile
public java.io.File getDestination()

Get the specification for the destination file to create. The default value is a file named "dependencies.gradle" in the same directory as the Ivy file.

Returns:

The destination file specification.

setDestination

public void setDestination(java.lang.Object pPath)

Set the path of the destination file to create. The specified path will be resolved relative to the project directory.

Parameters:

pPath - The destination file path. Passing null will cause the default value to be returned from getDestination.

convertIvyFile

public void convertIvyFile()

Import configurations and/or dependencies from the Ivy file specified in the ivyFile property and write them on Gradle notation to the file specified in the destination property.