Package com.intellij.openapi.vfs

Class VirtualFileVisitor<T>

java.lang.Object

com.intellij.openapi.vfs.VirtualFileVisitor<T>

public abstract class VirtualFileVisitor<T>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualFileVisitor.Option
static class	VirtualFileVisitor.Result
protected static class	VirtualFileVisitor.VisitorException

Field Summary

Fields

Modifier and Type	Field and Description
static VirtualFileVisitor.Result	CONTINUE
static VirtualFileVisitor.Option	NO_FOLLOW_SYMLINKS
static VirtualFileVisitor.Option	ONE_LEVEL_DEEP
static VirtualFileVisitor.Result	SKIP_CHILDREN
static VirtualFileVisitor.Option	SKIP_ROOT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualFileVisitor(VirtualFileVisitor.Option... options)

Method Summary

Modifier and Type	Method and Description
void	afterChildrenVisited(VirtualFile file) This method is only called if visiting wasn't interrupted (by returning skip-requesting result from visitFile(VirtualFile) or visitFileEx(VirtualFile) methods).
java.lang.Iterable<VirtualFile>	getChildrenIterable(VirtualFile file) By default, visitor uses (VirtualFile.getChildren()) to iterate over file's children.
T	getCurrentValue()
static VirtualFileVisitor.Option	limit(int maxDepth)
void	setValueForChildren(T value) Stores the value to this visitor.
static VirtualFileVisitor.Result	skipTo(VirtualFile parentToSkipTo)
boolean	visitFile(VirtualFile file) Simple visiting method.
VirtualFileVisitor.Result	visitFileEx(VirtualFile file) Extended visiting method.

Methods inherited from class java.lang.Object

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

Field Detail

NO_FOLLOW_SYMLINKS

public static final VirtualFileVisitor.Option NO_FOLLOW_SYMLINKS

SKIP_ROOT

public static final VirtualFileVisitor.Option SKIP_ROOT

ONE_LEVEL_DEEP

public static final VirtualFileVisitor.Option ONE_LEVEL_DEEP

CONTINUE

public static final VirtualFileVisitor.Result CONTINUE

SKIP_CHILDREN

public static final VirtualFileVisitor.Result SKIP_CHILDREN

Constructor Detail

VirtualFileVisitor

protected VirtualFileVisitor(VirtualFileVisitor.Option... options)

Method Detail

limit

public static VirtualFileVisitor.Option limit(int maxDepth)

skipTo

public static VirtualFileVisitor.Result skipTo(VirtualFile parentToSkipTo)

visitFile

public boolean visitFile(VirtualFile file)

Simple visiting method. On returning true a visitor will proceed to file's children, on false - to file's next sibling.

Parameters:

file - a file to visit.

Returns:

true to proceed to file's children, false to skip to file's next sibling.

visitFileEx

public VirtualFileVisitor.Result visitFileEx(VirtualFile file)

Extended visiting method.

Parameters:

file - a file to visit.

Returns:

CONTINUE to proceed to file's children,
SKIP_CHILDREN to skip to file's next sibling,
result of skipTo(VirtualFile) to skip to given file's next sibling.

afterChildrenVisited

public void afterChildrenVisited(VirtualFile file)

This method is only called if visiting wasn't interrupted (by returning skip-requesting result from visitFile(VirtualFile) or visitFileEx(VirtualFile) methods).

Parameters:

file - a file whose children were successfully visited.

getChildrenIterable

public java.lang.Iterable<VirtualFile> getChildrenIterable(VirtualFile file)

By default, visitor uses (VirtualFile.getChildren()) to iterate over file's children. You can override this method to implement another mechanism.

Parameters:

file - a virtual file to get children from.

Returns:

children iterable, or null to use VirtualFile.getChildren().

setValueForChildren

public final void setValueForChildren(T value)

Stores the value to this visitor. The stored value can be retrieved later by calling the getCurrentValue(). The visitor maintains the stack of stored values. I.e: This value is held here only during the visiting the current file and all its children. As soon as the visitor finished with the current file and all its subtree and returns to the level up, the value is cleared and the getCurrentValue() returns the previous value, which was stored here before this method call.

getCurrentValue

public final T getCurrentValue()