com.inet.gradle.setup

Class SetupBuilder

java.lang.Object

com.inet.gradle.setup.abstracts.AbstractSetupBuilder

com.inet.gradle.setup.SetupBuilder

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

public class SetupBuilder
extends AbstractSetupBuilder
implements SetupSources

The Gradle extension for all setup tasks.

Field Summary

Fields inherited from class com.inet.gradle.setup.abstracts.AbstractSetupBuilder

project

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deleteFiles(java.lang.String pattern) Add a file pattern to delete files before install and after uninstall.
void	deleteFolder(java.lang.String folder) Add a folder to delete before install and after uninstall.
void	desktopStarter(org.gradle.api.Action<? super DesktopStarter> action) Register a desktop starter.
void	desktopStarter(groovy.lang.Closure<?> closue) Register a desktop starter.
java.lang.String	getDefaultResourceLanguage()
java.util.List<java.lang.String>	getDeleteFiles() Get the list pattern for files that should be deleted.
java.util.List<java.lang.String>	getDeleteFolders() Get the list of folders to delete.
java.util.List<DesktopStarter>	getDesktopStarters() Returns the registered desktop starters.
java.io.File	getLicenseFile(java.lang.String locale) Return the license file for a specific locale
java.util.List<LocalizedResource>	getLicenseFiles() Return the license files
java.io.File	getLongDescription(java.lang.String locale) Return the description file for a specific locale
java.util.List<LocalizedResource>	getLongDescriptions() Return the description files
java.lang.String	getMinimumUpdateMessage() Return the minimum supported version error message.
java.lang.String	getMinimumUpdateVersion() Return the minimum supported version for an update.
DesktopStarter	getRunAfter() A command that run after the installer.
DesktopStarter	getRunBeforeUninstall() A command that run before the uninstaller.
java.util.List<Service>	getServices() Returns the registered services.
void	licenseFile(java.lang.Object license) Add a license file
void	longDescription(java.lang.Object description) Set the description file
void	minimumUpdateVersion(java.lang.String version) Set the oldest version which will be updated.
void	minimumUpdateVersion(java.lang.String version, java.lang.String message) Set the oldest version which will be updated.
void	runAfter(org.gradle.api.Action<? super DesktopStarter> action) Set a command that run after the installer.
void	runAfter(groovy.lang.Closure<?> closure) Set a command that run after the installer.
void	runBeforeUninstall(org.gradle.api.Action<? super DesktopStarter> action) Set a command that run run before the uninstaller.
void	runBeforeUninstall(groovy.lang.Closure<DesktopStarter> closue) Set a command that run run before the uninstaller.
void	service(org.gradle.api.Action<? super Service> action) Register a service.
void	service(groovy.lang.Closure<Service> closue) Register a service.
void	setDefaultResourceLanguage(java.lang.String defaultResourceLanguage)
void	setLicenseFile(java.lang.Object license) Set the license file
void	setMinimumUpdateMessage(java.lang.String version) Set the oldest version which will be updated.
void	setRunAfter(java.lang.String runAfter) Set a command that run after the installer.
void	setRunBeforeUninstall(java.lang.String runAfter) Set a command that run before the uninstaller.

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractSetupBuilder

getAppIdentifier, getApplication, getArchiveName, getBundleJre, getBundleJreTarget, getCopyright, getDescription, getDestinationDir, getIconForType, getIcons, getMainClass, getMainJar, getProject, getRootSpec, getSource, getVendor, getVersion, isFailOnEmptyFrom, setAppIdentifier, setApplication, setArchiveName, setBundleJre, setBundleJreTarget, setCopyright, setDescription, setDestinationDir, setFailOnEmptyFrom, setIcons, setMainClass, setMainJar, setVendor, setVersion

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, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirMode, getDuplicatesStrategy, getExcludes, getFileMode, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getSource, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

Methods inherited from interface org.gradle.api.internal.file.copy.CopySpecSource

getRootSpec

Constructor Detail

SetupBuilder

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

Create a new instance.

Parameters:

project - current project

Method Detail

getLicenseFiles

public java.util.List<LocalizedResource> getLicenseFiles()

Return the license files

Returns:

licenseFiles list of license files

getLicenseFile

public java.io.File getLicenseFile(java.lang.String locale)

Return the license file for a specific locale

Parameters:

locale - for which to get the file

Returns:

license file

setLicenseFile

public void setLicenseFile(java.lang.Object license)

Set the license file

Parameters:

license - license file or closure

licenseFile

public void licenseFile(java.lang.Object license)

Add a license file

Parameters:

license - license file or closure

getRunAfter

public DesktopStarter getRunAfter()

A command that run after the installer.

Returns:

the command or null

setRunAfter

public void setRunAfter(java.lang.String runAfter)

Set a command that run after the installer.

Parameters:

runAfter - the command

runAfter

public void runAfter(groovy.lang.Closure<?> closure)

Set a command that run after the installer.

Parameters:

closure - the command

runAfter

public void runAfter(org.gradle.api.Action<? super DesktopStarter> action)

Set a command that run after the installer.

Parameters:

action - the command

getRunBeforeUninstall

public DesktopStarter getRunBeforeUninstall()

A command that run before the uninstaller.

Returns:

the command or null

setRunBeforeUninstall

public void setRunBeforeUninstall(java.lang.String runAfter)

Set a command that run before the uninstaller.

Parameters:

runAfter - the command

runBeforeUninstall

public void runBeforeUninstall(groovy.lang.Closure<DesktopStarter> closue)

Set a command that run run before the uninstaller.

Parameters:

closue - the command

runBeforeUninstall

public void runBeforeUninstall(org.gradle.api.Action<? super DesktopStarter> action)

Set a command that run run before the uninstaller.

Parameters:

action - the command

service

public void service(groovy.lang.Closure<Service> closue)

Register a service.

Parameters:

closue - the closure of the service definition

service

public void service(org.gradle.api.Action<? super Service> action)

Register a service.

Parameters:

action - the closure of the service definition

getServices

public java.util.List<Service> getServices()

Returns the registered services.

Returns:

the registered services

desktopStarter

public void desktopStarter(groovy.lang.Closure<?> closue)

Register a desktop starter.

Parameters:

closue - the closure of the desktop starter's definition

desktopStarter

public void desktopStarter(org.gradle.api.Action<? super DesktopStarter> action)

Register a desktop starter.

Parameters:

action - the closure of the desktop starter's definition

getDesktopStarters

public java.util.List<DesktopStarter> getDesktopStarters()

Returns the registered desktop starters.

Returns:

the registered desktop starters, never null, can be empty.

getDeleteFiles

public java.util.List<java.lang.String> getDeleteFiles()

Get the list pattern for files that should be deleted.

Returns:

the list

deleteFiles

public void deleteFiles(java.lang.String pattern)

Add a file pattern to delete files before install and after uninstall.

Parameters:

pattern - the patter. Can contains * and ? characters

getDeleteFolders

public java.util.List<java.lang.String> getDeleteFolders()

Get the list of folders to delete.

Returns:

the list

deleteFolder

public void deleteFolder(java.lang.String folder)

Add a folder to delete before install and after uninstall. It delete the folder with all sub directories.

Parameters:

folder - the folder

getDefaultResourceLanguage

public java.lang.String getDefaultResourceLanguage()

Returns:

the defaultResourceLanguage

setDefaultResourceLanguage

public void setDefaultResourceLanguage(java.lang.String defaultResourceLanguage)

Parameters:

defaultResourceLanguage - the defaultResourceLanguage to set

getLongDescriptions

public java.util.List<LocalizedResource> getLongDescriptions()

Return the description files

Returns:

licenseFiles list of license files

getLongDescription

public java.io.File getLongDescription(java.lang.String locale)

Return the description file for a specific locale

Parameters:

locale - for which to get the file

Returns:

license file

longDescription

public void longDescription(java.lang.Object description)

Set the description file

Parameters:

description - file or closure

getMinimumUpdateVersion

public java.lang.String getMinimumUpdateVersion()

Return the minimum supported version for an update.

Returns:

the version or null

getMinimumUpdateMessage

public java.lang.String getMinimumUpdateMessage()

Return the minimum supported version error message.

Returns:

the message or null

setMinimumUpdateMessage

public void setMinimumUpdateMessage(java.lang.String version)

Set the oldest version which will be updated. If an already installed version is older then the update will be cancel. A default error message is used.

Parameters:

version - the version

minimumUpdateVersion

public void minimumUpdateVersion(java.lang.String version)

Set the oldest version which will be updated. If an already installed version is older then the update will be cancel. A default error message is used.

Parameters:

version - the version

minimumUpdateVersion

public void minimumUpdateVersion(java.lang.String version,
                                 java.lang.String message)

Set the oldest version which will be updated. If an already installed version is older then the update will be cancel. If no message is set a default error message is used.

Parameters:

version - the version

message - the error message for the user