FileNameMatcher (Search API)

Skip navigation links

org.netbeans.api.search 1.20.1

Prev Class
Next Class

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.netbeans.api.search.provider.FileNameMatcher

```
public abstract class FileNameMatcher
extends java.lang.Object
```
File name Matcher - Instances of this class are used to tell which file paths matches criteria defined in search options. Use factory method 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

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static FileNameMatcher`	`create(SearchScopeOptions options)`	Create an appripriate matcher for specific search options.
`abstract boolean`	`pathMatches(java.io.File file)`
`abstract boolean`	`pathMatches(java.net.URI uri)`
`abstract boolean`	`pathMatches(org.openide.filesystems.FileObject fileObject)`

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(java.io.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(org.openide.filesystems.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(java.net.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.

Skip navigation links

org.netbeans.api.search 1.20.1

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Built on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.