Package org.apache.commons.vfs2.tasks

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

    Fields
    Modifier and Type
    Field
    Description
    private static final String
    INDENT
     
    private boolean
    recursive
     
    private boolean
    showContent
     
    private String
    url
     

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

    target, taskName, taskType, wrapper

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

    description, location, project

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShowFileTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
    Executes the task.
    private void
    logContent(FileObject file, String prefix)
    Writes the content of the file to Ant log.
    void
    setFile(String url)
    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.
    private void
    showFile(FileObject file, String prefix)
    Logs the details of a file.

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

    closeManager, resolveFile

    Methods inherited from class org.apache.tools.ant.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

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

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • INDENT

      private static final String INDENT
      See Also:

    • url

      private String url

    • showContent

      private boolean showContent

    • recursive

      private boolean recursive

  • Constructor Details

    • ShowFileTask

      public ShowFileTask()

  • Method Details

    • setFile

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

    • setShowContent

      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.

    • setRecursive

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

    • execute

      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.

    • showFile

      private void showFile(FileObject file, String prefix) throws Exception
      Logs the details of a file.
      Throws:
      Exception

    • logContent

      private void logContent(FileObject file, String prefix) throws Exception
      Writes the content of the file to Ant log.
      Throws:
      Exception