org.netbeans.spi.jumpto.file

Class FileProvider.Context

java.lang.Object

org.netbeans.spi.jumpto.file.FileProvider.Context

Enclosing interface:

FileProvider

public static final class FileProvider.Context
extends Object

Represents search context. Contains search type (such as prefix, regexp), search text, SourceGroup root and project where to search.

Method Summary

Modifier and Type	Method and Description
int	getLineNumber() Returns a line number on which the file should be opened.
Project	getProject() Returns project owning the SourceGroup root
FileObject	getRoot() Returns the SourceGroup root to search files in.
SearchType	getSearchType() Return the type of search.
String	getText() Return the text used for search.

Methods inherited from class java.lang.Object

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

Method Detail

getProject

public Project getProject()

Returns project owning the SourceGroup root

Returns:

project to search in.

getRoot

public FileObject getRoot()

Returns the SourceGroup root to search files in.

Returns:

root to search in.

getText

public String getText()

Return the text used for search.

Returns:

The text used for the search; e.g. when getSearchType() == SearchType.PREFIX, text is the prefix that all returned types should start with.

getSearchType

public SearchType getSearchType()

Return the type of search.

Returns:

Type of search performed, such as prefix, regexp or camel case.

getLineNumber

public int getLineNumber()

Returns a line number on which the file should be opened.

Returns:

the preferred line number or -1 if no preferred line number is given.

Since:

1.30