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 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 and Description
ShowFileTask() Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the task.
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.

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

Constructor Detail

ShowFileTask

public ShowFileTask()

Constructs a new instance.

Method Detail

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.

setFile

public void setFile(String url)

The URL of the file to display.

Parameters:

url - The url of the file.

setRecursive

public void setRecursive(boolean recursive)

Recursively shows the descendants of the file.

Parameters:

recursive - true if descendants should be shown.

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.