org.eclipse.core.resources.ant
Class RefreshLocalTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.eclipse.core.resources.ant.RefreshLocalTask

All Implemented Interfaces:

java.lang.Cloneable

public class RefreshLocalTask
extends org.apache.tools.ant.Task

An Ant task which refreshes the Eclipse Platform's view of the local filesystem.

See Also:

IResource.refreshLocal(int, IProgressMonitor)

Field Summary

static java.lang.String	DEPTH_INFINITE Unique identifier constant (value "DEPTH_INFINITE") indicating that refreshes should be performed on the target resource and all of its recursive children
static java.lang.String	DEPTH_ONE Unique identifier constant (value "DEPTH_ONE") indicating that refreshes should be performed on the target resource and its children
static java.lang.String	DEPTH_ZERO Unique identifier constant (value "DEPTH_ZERO") indicating that refreshes should be performed only on the target resource itself

Constructor Summary

RefreshLocalTask()
Constructs a new RefreshLocal instance.

Method Summary

void	execute() Performs the refresh operation.
void	setDepth(java.lang.String value) Sets the depth of this task appropriately.
void	setResource(java.lang.String value) Sets the root of the workspace resource tree to refresh.

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, init, 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEPTH_ZERO

public static final java.lang.String DEPTH_ZERO

Unique identifier constant (value "DEPTH_ZERO") indicating that refreshes should be performed only on the target resource itself

See Also:

Constant Field Values

DEPTH_ONE

public static final java.lang.String DEPTH_ONE

Unique identifier constant (value "DEPTH_ONE") indicating that refreshes should be performed on the target resource and its children

See Also:

Constant Field Values

DEPTH_INFINITE

public static final java.lang.String DEPTH_INFINITE

Unique identifier constant (value "DEPTH_INFINITE") indicating that refreshes should be performed on the target resource and all of its recursive children

See Also:

Constant Field Values

Constructor Detail

RefreshLocalTask

public RefreshLocalTask()

Constructs a new RefreshLocal instance.

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Performs the refresh operation.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - thrown if a problem occurs during execution.

setDepth

public void setDepth(java.lang.String value)

Sets the depth of this task appropriately. The specified argument must by one of RefreshLocal.DEPTH_ZERO, RefreshLocal.DEPTH_ONE or RefreshLocal.DEPTH_INFINITE.

Parameters:

value - the depth to refresh to

setResource

public void setResource(java.lang.String value)

Sets the root of the workspace resource tree to refresh.

Parameters:

value - the root value