org.netbeans.api.search.provider

Class FileNameMatcher

java.lang.Object

org.netbeans.api.search.provider.FileNameMatcher

public abstract class FileNameMatcher
extends Object

File name Matcher - Instances of this class are used to tell which file paths matches criteria defined in search options. Use factory method FileNameMatcher.create(SearchScopeOptions) to get optimal implementation for specific search scope options.

If search scope handles file name pattern as regular expression, full path is matched by the implementation. Otherwise, only file name and extension is matched.

Method Summary

Modifier and Type	Method and Description
static FileNameMatcher	create(SearchScopeOptions options) Create an appripriate matcher for specific search options.
abstract boolean	pathMatches(File file)
abstract boolean	pathMatches(FileObject fileObject)
abstract boolean	pathMatches(URI uri)

Methods inherited from class java.lang.Object

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

Method Detail

pathMatches

public abstract boolean pathMatches(File file)

Parameters:

file - File whose name or path should be matched.

Returns:

True if file path matches required criteria, false otherwise.

pathMatches

public abstract boolean pathMatches(FileObject fileObject)

Parameters:

fileObject - File whose name or path should be matched.

Returns:

True if file path matches required criteria, false otherwise.

pathMatches

public abstract boolean pathMatches(URI uri)

Parameters:

uri - URI whose name or path should be matched.

Returns:

True if the URI matches required criteria, false otherwise.

Since:

org.netbeans.api.search/1.4

create

public static FileNameMatcher create(SearchScopeOptions options)

Create an appripriate matcher for specific search options.