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

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

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
SplashTask()

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute the task.
void	setDisplayText(String displayText)	Sets the display text presented in the splash window.
void	setImageURL(String imgurl)	A URL pointing to an image to display; optional, default antlogo.gif from the classpath.
void	setPassword(String password)	Deprecated. since 1.5.x.
void	setPort(String port)	Deprecated. since 1.5.x.
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
void	setProxy(String proxy)	Deprecated. since 1.5.x.
void	setShowduration(int duration)	how long to show the splash screen in milliseconds, optional; default 5000 ms.
void	setUseproxy(boolean useProxy)	Deprecated. since 1.5.x.
void	setUser(String user)	Deprecated. since 1.5.x.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

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

Constructor Details

SplashTask

public SplashTask()

Method Details

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

setUseproxy

@Deprecated
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

setProxy

@Deprecated
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

setPort

@Deprecated
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

setUser

@Deprecated
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

setPassword

@Deprecated
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

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(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(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

public void execute()
             throws BuildException

Execute the task.

Overrides:

execute in class Task

Throws:

BuildException - on error