org.apache.commons.vfs.tasks
Class ShowFileTask

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

public class ShowFileTask
extends VfsTask

An Ant task that writes the details of a file to Ant's log.

Version:
$Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
Author:
Adam Murdoch

Field Summary
private static java.lang.String INDENT
           
private  boolean recursive
           
private  boolean showContent
           
private  java.lang.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
ShowFileTask()
           
 
Method Summary
 void execute()
          Executes the task.
private  void logContent(FileObject file, java.lang.String prefix)
          Writes the content of the file to Ant log.
 void setFile(java.lang.String url)
          The URL of the file to display.
 void setRecursive(boolean recursive)
          Recursively shows the decendents of the file.
 void setShowContent(boolean showContent)
          Shows the content.
private  void showFile(FileObject file, java.lang.String prefix)
          Logs the details of a file.
 
Methods inherited from class org.apache.commons.vfs.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 Detail

url

private java.lang.String url

showContent

private boolean showContent

recursive

private boolean recursive

INDENT

private static final java.lang.String INDENT
See Also:
Constant Field Values
Constructor Detail

ShowFileTask

public ShowFileTask()
Method Detail

setFile

public void setFile(java.lang.String url)
The URL of the file to display.


setShowContent

public void setShowContent(boolean showContent)
Shows the content. Assumes the content is text, encoded using the platform's default encoding.


setRecursive

public void setRecursive(boolean recursive)
Recursively shows the decendents of the file.


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

showFile

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

Throws:
java.lang.Exception

logContent

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

Throws:
java.lang.Exception