org.jboss.vfs.util

Class FilterVirtualFileVisitor

java.lang.Object

org.jboss.vfs.util.AbstractVirtualFileVisitor

org.jboss.vfs.util.FilterVirtualFileVisitor

All Implemented Interfaces:

VirtualFileVisitor

public class FilterVirtualFileVisitor
extends AbstractVirtualFileVisitor

A visitor based on a virtual file filter

Version:

$Revision: 1.1 $

Field Summary

Fields

Modifier and Type	Field and Description
private VirtualFileFilter	filter The filter
private java.util.List<VirtualFile>	matched What is matched

Constructor Summary

Constructors

Constructor and Description
FilterVirtualFileVisitor(VirtualFileFilter filter) Create a new FilterVirtualFileVisitor with default attributes
FilterVirtualFileVisitor(VirtualFileFilter filter, VisitorAttributes attributes) Create a new FilterVirtualFileVisitor.

Method Summary

Modifier and Type	Method and Description
private static VisitorAttributes	checkAttributes(VirtualFileFilter filter, VisitorAttributes attributes) Check the attributes
java.util.List<VirtualFile>	getMatched() Get the matched files
void	visit(VirtualFile virtualFile) Visit a virtual file

Methods inherited from class org.jboss.vfs.util.AbstractVirtualFileVisitor

getAttributes

Methods inherited from class java.lang.Object

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

Field Detail

filter

private final VirtualFileFilter filter

The filter

matched

private java.util.List<VirtualFile> matched

What is matched

Constructor Detail

FilterVirtualFileVisitor

public FilterVirtualFileVisitor(VirtualFileFilter filter)

Create a new FilterVirtualFileVisitor with default attributes

Parameters:

filter - the filter

Throws:

java.lang.IllegalArgumentException - if the filter is null

FilterVirtualFileVisitor

public FilterVirtualFileVisitor(VirtualFileFilter filter,
                                VisitorAttributes attributes)

Create a new FilterVirtualFileVisitor.

Parameters:

filter - the filter

attributes - the attributes, uses the default if null

Throws:

java.lang.IllegalArgumentException - if the filter is null

Method Detail

checkAttributes

private static VisitorAttributes checkAttributes(VirtualFileFilter filter,
                                                 VisitorAttributes attributes)

Check the attributes

Parameters:

filter - the filter

attributes - the attributes

Returns:

the attributes

Throws:

java.lang.IllegalArgumentException - for a null filter

getMatched

public java.util.List<VirtualFile> getMatched()

Get the matched files

Returns:

the matched files

visit

public void visit(VirtualFile virtualFile)

Description copied from interface: VirtualFileVisitor

Visit a virtual file

Parameters:

virtualFile - the virtual file being visited