Class ShowFileTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.commons.vfs2.tasks.VfsTask
org.apache.commons.vfs2.tasks.ShowFileTask
All Implemented Interfaces:
Cloneable

public class ShowFileTask extends VfsTask
An Ant task that writes the details of a file to Ant's log.
  • Field Summary Link icon

    Fields inherited from class org.apache.tools.ant.Task Link icon

    target, taskName, taskType, wrapper

    Fields inherited from class org.apache.tools.ant.ProjectComponent Link icon

    description, location, project
  • Constructor Summary Link icon

    Constructors
    Constructor
    Description
    Constructs a new instance.
  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    void
    Executes the task.
    void
    The URL of the file to display.
    void
    setRecursive(boolean recursive)
    Recursively shows the descendants of the file.
    void
    setShowContent(boolean showContent)
    Shows the content.

    Methods inherited from class org.apache.commons.vfs2.tasks.VfsTask Link icon

    closeManager, resolveFile

    Methods inherited from class org.apache.tools.ant.Task Link icon

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

    Methods inherited from class org.apache.tools.ant.ProjectComponent Link icon

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

    Methods inherited from class java.lang.Object Link icon

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details Link icon

    • ShowFileTask Link icon

      public ShowFileTask()
      Constructs a new instance.
  • Method Details Link icon

    • execute Link icon

      public void execute() throws org.apache.tools.ant.BuildException
      Executes the task.
      Overrides:
      execute in class org.apache.tools.ant.Task
      Throws:
      org.apache.tools.ant.BuildException - if any exception is thrown.
    • setFile Link icon

      public void setFile(String url)
      The URL of the file to display.
      Parameters:
      url - The url of the file.
    • setRecursive Link icon

      public void setRecursive(boolean recursive)
      Recursively shows the descendants of the file.
      Parameters:
      recursive - true if descendants should be shown.
    • setShowContent Link icon

      public void setShowContent(boolean showContent)
      Shows the content. Assumes the content is text, encoded using the platform's default encoding.
      Parameters:
      showContent - true if the content should be shown.