Class SplashTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.splash.SplashTask
- All Implemented Interfaces:
java.lang.Cloneable
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
-
Field Summary
-
Constructor Summary
Constructors Constructor Description SplashTask() -
Method Summary
Modifier and Type Method Description voidexecute()Execute the task.voidsetDisplayText(java.lang.String displayText)Sets the display text presented in the splash window.voidsetImageURL(java.lang.String imgurl)A URL pointing to an image to display; optional, default antlogo.gif from the classpath.voidsetPassword(java.lang.String password)Deprecated.since 1.5.x.voidsetPort(java.lang.String port)Deprecated.since 1.5.x.voidsetProgressRegExp(java.lang.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 linevoidsetProxy(java.lang.String proxy)Deprecated.since 1.5.x.voidsetShowduration(int duration)how long to show the splash screen in milliseconds, optional; default 5000 ms.voidsetUseproxy(boolean useProxy)Deprecated.since 1.5.x.voidsetUser(java.lang.String user)Deprecated.since 1.5.x.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
SplashTask
public SplashTask()
-
-
Method Details
-
setImageURL
public void setImageURL(java.lang.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
-
setUseproxy
@Deprecated public void setUseproxy(boolean useProxy)Deprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyflag to enable proxy settings; optional, deprecated : consider using <setproxy> instead- Parameters:
useProxy- if ture, enable proxy settings
-
setProxy
@Deprecated public void setProxy(java.lang.String proxy)Deprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyname of proxy; optional.- Parameters:
proxy- the name of the proxy host
-
setPort
@Deprecated public void setPort(java.lang.String port)Deprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyProxy port; optional, default 80.- Parameters:
port- the proxy port
-
setUser
@Deprecated public void setUser(java.lang.String user)Deprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyProxy user; optional, default =none.- Parameters:
user- the proxy user
-
setPassword
@Deprecated public void setPassword(java.lang.String password)Deprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyProxy password; required ifuseris set.- Parameters:
password- the proxy password
-
setShowduration
public void setShowduration(int duration)how long to show the splash screen in milliseconds, optional; default 5000 ms.- Parameters:
duration- the splash duration in milliseconds
-
setProgressRegExp
public void setProgressRegExp(java.lang.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
-
setDisplayText
public void setDisplayText(java.lang.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
-
execute
Execute the task.- Overrides:
executein classTask- Throws:
BuildException- on error
-