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

public class ShowFileTask
extends VfsTask

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

Author:

Commons VFS team

Field Summary

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

description, location, target, taskName, taskType, wrapper

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

project

Constructor Summary

ShowFileTask()

Method Summary

void	execute() Executes the task.
void	setFile(String url) The URL of the file to display.
void	setRecursive(boolean recursive) Recursively shows the descendents of the file.
void	setShowContent(boolean showContent) Shows the content.

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

closeManager, resolveFile

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

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

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

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowFileTask

public ShowFileTask()

Method Detail

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 descendents of the file.

Parameters:

recursive - true if descendents 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.