API Overview API Index Package Overview Direct link to this page
Apache Ant 1.7.1
  org.apache.tools.ant.taskdefs.optional.sound. SoundTask View Source
Author(s)
Since
Version
Serial
Hierarchy
 Object
      ProjectComponent
          Task
              SoundTask
Implements
Subclasses
Description
public class SoundTask
  Plays a sound file at the end of the build, according to whether the build failed or succeeded.
See also:   
Constructors
public SoundTask ()
Constructor for SoundTask.
Methods
Hide/Show inherited methods
publicfinal void bindToOwner (Task owner) [Inherited From Task]
  Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
public java.lang.Object clone () throws java.lang.CloneNotSupportedException [Inherited From ProjectComponent]
 
public BuildAlert createFail ()
  add a sound when the build fails
public BuildAlert createSuccess ()
  add a sound when the build succeeds
public void execute () [Overrides Task]
Execute the task.
public java.lang.String getDescription () [Inherited From ProjectComponent]
  Returns the description of the current action.
public Location getLocation () [Inherited From ProjectComponent]
  Returns the file/location where this task was defined.
public Target getOwningTarget () [Inherited From Task]
  Returns the container target of this task.
public Project getProject () [Inherited From ProjectComponent]
  Returns the project to which this component belongs.
public RuntimeConfigurable getRuntimeConfigurableWrapper () [Inherited From Task]
  Returns the wrapper used for runtime configuration.
public java.lang.String getTaskName () [Inherited From Task]
  Returns the name to use in logging messages.
public java.lang.String getTaskType () [Inherited From Task]
  Return the type of task.
protected RuntimeConfigurable getWrapper () [Inherited From Task]
  Return the runtime configurable structure for this task.
protected void handleErrorFlush (java.lang.String output) [Inherited From Task]
  Handles an error line by logging it with the WARN priority.
protected void handleErrorOutput (java.lang.String output) [Inherited From Task]
  Handles an error output by logging it with the WARN priority.
protected void handleFlush (java.lang.String output) [Inherited From Task]
  Handles output by logging it with the INFO priority.
protected int handleInput (byte[] buffer, int offset, int length) throws java.io.IOException [Inherited From Task]
  Handle an input request by this task.
protected void handleOutput (java.lang.String output) [Inherited From Task]
  Handles output by logging it with the INFO priority.
public void init () [Overrides Task]
Initialize the task.
protectedfinal boolean isInvalid () [Inherited From Task]
  Has this task been marked invalid?
public void log (java.lang.String msg) [Inherited From Task]
  Logs a message with the default (INFO) priority.
public void log (java.lang.String msg, int msgLevel) [Inherited From Task]
  Logs a message with the given priority.
public void log (java.lang.String msg, java.lang.Throwable t, int msgLevel) [Inherited From Task]
  Logs a message with the given priority.
public void log (java.lang.Throwable t, int msgLevel) [Inherited From Task]
  Logs a message with the given priority.
public void maybeConfigure () throws BuildException [Inherited From Task]
  Configures this task - if it hasn't been done already.
publicfinal void perform () [Inherited From Task]
  Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
public void reconfigure () [Inherited From Task]
Force the task to be reconfigured from its RuntimeConfigurable.
public void setDescription (java.lang.String desc) [Inherited From ProjectComponent]
  Sets a description of the current action.
public void setLocation (Location location) [Inherited From ProjectComponent]
  Sets the file/location where this task was defined.
public void setOwningTarget (Target target) [Inherited From Task]
  Sets the target container of this task.
public void setProject (Project project) [Inherited From ProjectComponent]
  Sets the project object of this component.
public void setRuntimeConfigurableWrapper (RuntimeConfigurable wrapper) [Inherited From Task]
  Sets the wrapper to be used for runtime configuration.
public void setTaskName (java.lang.String name) [Inherited From Task]
  Sets the name to use in logging messages.
public void setTaskType (java.lang.String type) [Inherited From Task]
  Sets the name with which the task has been invoked.
Fields
Hide/Show inherited fields
protected java.lang.String description [Inherited From ProjectComponent]
Description of this component, if any.
protected Location location [Inherited From ProjectComponent]
Location within the build file of this task definition.
protected Project project [Inherited From ProjectComponent]
Project object of this component.
protected Target target [Inherited From Task]
Target this task belongs to, if any.
protected java.lang.String taskName [Inherited From Task]
  Name of this task to be used for logging purposes.
protected java.lang.String taskType [Inherited From Task]
Type of this task.
protected RuntimeConfigurable wrapper [Inherited From Task]
Wrapper for this object, used to configure it at runtime.
Nested Classes
  SoundTask.BuildAlert
A class to be extended by any BuildAlert's that require the output of sound.
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar