Class Echo

All Implemented Interfaces:
Cloneable

public class Echo extends Task
Writes a message to the Ant logging facilities.
Since:
Ant 1.1
  • Field Details

    • message

      protected String message
    • file

      protected File file
    • append

      protected boolean append
    • logLevel

      protected int logLevel
  • Constructor Details

    • Echo

      public Echo()
  • Method Details

    • execute

      public void execute() throws BuildException
      Does the work.
      Overrides:
      execute in class Task
      Throws:
      BuildException - if something goes wrong with the build
    • setMessage

      public void setMessage(String msg)
      Message to write.
      Parameters:
      msg - Sets the value for the message variable.
    • setFile

      public void setFile(File file)
      File to write to.
      Parameters:
      file - the file to write to, if not set, echo to standard output
    • setOutput

      public void setOutput(Resource output)
      Resource to write to.
      Parameters:
      output - the Resource to write to.
      Since:
      Ant 1.8
    • setAppend

      public void setAppend(boolean append)
      If true, append to existing file.
      Parameters:
      append - if true, append to existing file, default is false.
    • addText

      public void addText(String msg)
      Set a multiline message.
      Parameters:
      msg - the CDATA text to append to the output text
    • setLevel

      public void setLevel(Echo.EchoLevel echoLevel)
      Set the logging level. Level should be one of
      • error
      • warning
      • info
      • verbose
      • debug

      The default is "warning" to ensure that messages are displayed by default when using the -quiet command line option.

      Parameters:
      echoLevel - the logging level
    • setEncoding

      public void setEncoding(String encoding)
      Declare the encoding to use when outputting to a file; Use "" for the platform's default encoding.
      Parameters:
      encoding - the character encoding to use.
      Since:
      1.7
    • setForce

      public void setForce(boolean f)
      Whether read-only destinations will be overwritten.

      Defaults to false

      Parameters:
      f - boolean
      Since:
      Ant 1.8.2