org.apache.tools.ant.taskdefs.optional.splash

Class SplashTask

public class SplashTask extends Task

Creates a splash screen. The splash screen is displayed for the duration of the build and includes a handy progress bar as well. Use in conjunction with the sound task to provide interest whilst waiting for your builds to complete...

Since: Ant1.5

Method Summary
voidexecute()
Execute the task.
voidsetDisplayText(String displayText)
Sets the display text presented in the splash window. optional; defaults to "Building ..."
voidsetImageURL(String imgurl)
A URL pointing to an image to display; optional, default antlogo.gif from the classpath.
voidsetPassword(String password)
Proxy password; required if user is set.
voidsetPort(String port)
Proxy port; optional, default 80.
voidsetProgressRegExp(String progressRegExp)
Progress regular expression which is used to parse the output and dig out current progress optional; if not provided, progress is increased every action and log output line
voidsetProxy(String proxy)
name of proxy; optional.
voidsetShowduration(int duration)
how long to show the splash screen in milliseconds, optional; default 5000 ms.
voidsetUseproxy(boolean useProxy)
flag to enable proxy settings; optional, deprecated : consider using <setproxy> instead
voidsetUser(String user)
Proxy user; optional, default =none.

Method Detail

execute

public void execute()
Execute the task.

Throws: BuildException on error

setDisplayText

public void setDisplayText(String displayText)
Sets the display text presented in the splash window. optional; defaults to "Building ..."

Parameters: displayText the display text presented the splash window

Since: Ant 1.8.0

setImageURL

public void setImageURL(String imgurl)
A URL pointing to an image to display; optional, default antlogo.gif from the classpath.

Parameters: imgurl the url string pointing to the image

setPassword

public void setPassword(String password)

Deprecated: since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxy

Proxy password; required if user is set.

Parameters: password the proxy password

setPort

public void setPort(String port)

Deprecated: since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxy

Proxy port; optional, default 80.

Parameters: port the proxy port

setProgressRegExp

public void setProgressRegExp(String progressRegExp)
Progress regular expression which is used to parse the output and dig out current progress optional; if not provided, progress is increased every action and log output line

Parameters: progressRegExp Progress regular expression, exactly one group pattern must exists, and it represents the progress number (0-100) (i.e "Progress: (.*)%")

Since: Ant 1.8.0

setProxy

public void setProxy(String proxy)

Deprecated: since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxy

name of proxy; optional.

Parameters: proxy the name of the proxy host

setShowduration

public void setShowduration(int duration)
how long to show the splash screen in milliseconds, optional; default 5000 ms.

Parameters: duration the spash duration in milliseconds

setUseproxy

public void setUseproxy(boolean useProxy)

Deprecated: since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxy

flag to enable proxy settings; optional, deprecated : consider using <setproxy> instead

Parameters: useProxy if ture, enable proxy settings

setUser

public void setUser(String user)

Deprecated: since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxy

Proxy user; optional, default =none.

Parameters: user the proxy user