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:
- Cloneable
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 SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidexecute()Execute the task.voidsetDisplayText(String displayText) Sets the display text presented in the splash window.voidsetImageURL(String imgurl) A URL pointing to an image to display; optional, default antlogo.gif from the classpath.voidsetPassword(String password) Deprecated.since 1.5.x.voidDeprecated.since 1.5.x.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 linevoidDeprecated.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.voidDeprecated.since 1.5.x.Methods inherited from class org.apache.tools.ant.TaskbindToOwner, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
SplashTaskpublic SplashTask()
 
- 
- 
Method Details- 
setImageURLA URL pointing to an image to display; optional, default antlogo.gif from the classpath.- Parameters:
- imgurl- the url string pointing to the image
 
- 
setUseproxyDeprecated.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
 
- 
setProxyDeprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyname of proxy; optional.- Parameters:
- proxy- the name of the proxy host
 
- 
setPortDeprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyProxy port; optional, default 80.- Parameters:
- port- the proxy port
 
- 
setUserDeprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyProxy user; optional, default =none.- Parameters:
- user- the proxy user
 
- 
setPasswordDeprecated.since 1.5.x. Use org.apache.tools.ant.taskdefs.optional.net.SetProxyProxy password; required ifuseris set.- Parameters:
- password- the proxy password
 
- 
setShowdurationpublic void setShowduration(int duration) how long to show the splash screen in milliseconds, optional; default 5000 ms.- Parameters:
- duration- the splash duration in milliseconds
 
- 
setProgressRegExpProgress 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
 
- 
setDisplayTextSets 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
 
- 
executeExecute the task.- Overrides:
- executein class- Task
- Throws:
- BuildException- on error
 
 
-