com.inet.gradle.setup.abstracts

Class AbstractSetupBuilder

java.lang.Object

com.inet.gradle.setup.abstracts.AbstractSetupBuilder

All Implemented Interfaces:

SetupSources, org.gradle.api.file.ContentFilterable, org.gradle.api.file.CopyProcessingSpec, org.gradle.api.file.CopySourceSpec, org.gradle.api.file.CopySpec, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.tasks.util.PatternFilterable

Direct Known Subclasses:

AppBundler, SetupBuilder

public class AbstractSetupBuilder
extends java.lang.Object
implements SetupSources

The Gradle extension for all setup tasks.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.gradle.api.Project	project

Constructor Summary

Constructors

Constructor and Description
AbstractSetupBuilder(org.gradle.api.Project project) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	documentType(groovy.lang.Closure<?> closue) Deprecated.
java.lang.String	getAppIdentifier() Get the short application identifier of the setup file.
java.lang.String	getApplication() Return the name of the application
java.lang.String	getArchiveName() Get the name of the setup file without extension.
java.lang.Object	getBundleJre() Get the bundle JRE value.
java.lang.String	getBundleJreTarget() Get the target for a bundle JRE.
java.lang.String	getCopyright() Get the Copyright information.
java.lang.String	getDescription() Get a global description.
java.io.File	getDestinationDir() Override to remove the annotation OutputDirectories in the Copy task.
java.util.List<DocumentType>	getDocumentType() Deprecated.
java.io.File	getIconForType(java.io.File buildDir, java.lang.String type) Retrieve a specific icon from the icons set for the setup
java.lang.Object	getIcons() Get the icons for the setup.
java.lang.String	getMainClass() Get the main class.
java.lang.String	getMainJar() Get the main jar file.
org.gradle.api.Project	getProject() Get the current project.
org.gradle.api.internal.file.copy.CopySpecInternal	getRootSpec()
org.gradle.api.file.FileTree	getSource() All the inputs
java.lang.String	getVendor() Vendor of this setup
java.lang.String	getVersion() Get the version of the setup.
boolean	isFailOnEmptyFrom() If enabled then an empty from definition is failing the build.
void	setAppIdentifier(java.lang.String identifier) Set the short application identifier for the setup file.
void	setApplication(java.lang.String application) Setup an application with specified type
void	setArchiveName(java.lang.String setupName) Set the name of the download file for the setup.
void	setBundleJre(java.lang.Object bundleJre) Add a Java VM into your setup.
void	setBundleJreTarget(java.lang.String bundleJreTarget) The target directory in the install directory for a bundled JRE.
void	setCopyright(java.lang.String copyright) Set the copyright information.
void	setDescription(java.lang.String description) Set a description for the installer.
void	setDestinationDir(java.lang.Object destinationDir) Sets the destination of this task.
void	setFailOnEmptyFrom(boolean failOnEmptyFrom) Enable the check.
void	setIcons(java.lang.Object icons) Set the icons for the setup.
void	setMainClass(java.lang.String mainClass) Set the main class of the Java application.
void	setMainJar(java.lang.String mainJar) Set the jar which contains the main class.
void	setVendor(java.lang.String vendor) Set the vendor
void	setVersion(java.lang.String version) Set the version of the setup.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inet.gradle.setup.abstracts.SetupSources

eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirMode, getDuplicatesStrategy, getExcludes, getFileMode, getFilteringCharset, getIncludeEmptyDirs, getIncludes, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

Field Detail

project

protected final org.gradle.api.Project project

Constructor Detail

AbstractSetupBuilder

public AbstractSetupBuilder(org.gradle.api.Project project)

Create a new instance.

Parameters:

project - current project

Method Detail

getRootSpec

public org.gradle.api.internal.file.copy.CopySpecInternal getRootSpec()

Specified by:

getRootSpec in interface org.gradle.api.internal.file.copy.CopySpecSource

getProject

public org.gradle.api.Project getProject()

Get the current project.

Returns:

the project

getDestinationDir

public java.io.File getDestinationDir()

Override to remove the annotation OutputDirectories in the Copy task.

getSource

public org.gradle.api.file.FileTree getSource()

All the inputs

Specified by:

getSource in interface SetupSources

Returns:

FileTree

setDestinationDir

public void setDestinationDir(java.lang.Object destinationDir)

Sets the destination of this task.

Parameters:

destinationDir - The destination directory. Must not be null.

getVendor

public java.lang.String getVendor()

Vendor of this setup

Returns:

vendor

setVendor

public void setVendor(java.lang.String vendor)

Set the vendor

Parameters:

vendor - vendor

getApplication

public java.lang.String getApplication()

Return the name of the application

Returns:

name of the application

setApplication

public void setApplication(java.lang.String application)

Setup an application with specified type

Parameters:

application - type of application

getVersion

public java.lang.String getVersion()

Get the version of the setup. If not set a version of 1.0 is returned

Returns:

the version

setVersion

public void setVersion(java.lang.String version)

Set the version of the setup.

Parameters:

version - the version

getAppIdentifier

public java.lang.String getAppIdentifier()

Get the short application identifier of the setup file. If not set then the project.archivesBaseName is used. Should not contain spaces if possible.

Returns:

the application identifier

setAppIdentifier

public void setAppIdentifier(java.lang.String identifier)

Set the short application identifier for the setup file.

Parameters:

identifier - new base name

getArchiveName

public java.lang.String getArchiveName()

Get the name of the setup file without extension. If not set then baseName-version is used.

Returns:

the setup file name

setArchiveName

public void setArchiveName(java.lang.String setupName)

Set the name of the download file for the setup. This should contain the version if needed

Parameters:

setupName - name of the setup

getIcons

public java.lang.Object getIcons()

Get the icons for the setup.

Returns:

the icons

getIconForType

public java.io.File getIconForType(java.io.File buildDir,
                                   java.lang.String type)
                            throws java.io.IOException

Retrieve a specific icon from the icons set for the setup

Parameters:

buildDir - directory in which to put the icon

type - of the icon to retrieve

Returns:

the icon file

Throws:

java.io.IOException - if an error occurs

setIcons

public void setIcons(java.lang.Object icons)

Set the icons for the setup. This can be one or multiple images in different size. The usage depends on the platform. This can be an *.ico file, *.icns file or an list of Java readable image files like *.png or *.jpeg.

Parameters:

icons - the icons

getBundleJre

public java.lang.Object getBundleJre()

Get the bundle JRE value.

Returns:

the value

setBundleJre

public void setBundleJre(java.lang.Object bundleJre)

Add a Java VM into your setup. The resulting behavior depends on the platform. This can be a version or a directory to a installed Java VM.

Parameters:

bundleJre - version or path

See Also:

setBundleJreTarget(String)

getBundleJreTarget

public java.lang.String getBundleJreTarget()

Get the target for a bundle JRE.

Returns:

the target

setBundleJreTarget

public void setBundleJreTarget(java.lang.String bundleJreTarget)

The target directory in the install directory for a bundled JRE. The default is "jre".

Parameters:

bundleJreTarget - the new value

getMainClass

public java.lang.String getMainClass()

Get the main class.

Returns:

the class name

setMainClass

public void setMainClass(java.lang.String mainClass)

Set the main class of the Java application.

Parameters:

mainClass - the class name

getMainJar

public java.lang.String getMainJar()

Get the main jar file.

Returns:

the main jar

setMainJar

public void setMainJar(java.lang.String mainJar)

Set the jar which contains the main class. This jar must contains all references to all other needed jar files in the manifest.

Parameters:

mainJar - the main jar file

documentType

@Deprecated
public void documentType(groovy.lang.Closure<?> closue)

Deprecated.

Register a file extensions.

Parameters:

closue - document type

getDocumentType

@Deprecated
public java.util.List<DocumentType> getDocumentType()

Deprecated.

Get the list of document types.

Returns:

the list

isFailOnEmptyFrom

public boolean isFailOnEmptyFrom()

If enabled then an empty from definition is failing the build.

Returns:

true, if enabled

setFailOnEmptyFrom

public void setFailOnEmptyFrom(boolean failOnEmptyFrom)

Enable the check.

Parameters:

failOnEmptyFrom - true, check is enabled

getDescription

public java.lang.String getDescription()

Get a global description. Never null.

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Set a description for the installer. This is used for the packages but also as default for shortcuts, service, etc.

Parameters:

description - new description

getCopyright

public java.lang.String getCopyright()

Get the Copyright information.

Returns:

the copyright notice

setCopyright

public void setCopyright(java.lang.String copyright)

Set the copyright information.

Parameters:

copyright - the copyright notice