org.netbeans.spi.jumpto.file

Class FileProvider.Result

java.lang.Object

org.netbeans.spi.jumpto.file.FileProvider.Result

Enclosing interface:

FileProvider

public static final class FileProvider.Result
extends Object

Represents a collection of files that match the given search criteria. Moreover, it can contain message for the user, such as an incomplete search result.

Method Summary

Modifier and Type	Method and Description
void	addFile(FileObject file) Adds a file into the result When the file is under processed SourceGroup relative path is displayed in the dialog.
void	addFileDescriptor(FileDescriptor desc) Adds a FileDescriptor into the result
void	pendingResult() Notify caller that a provider should be called again because of incomplete or inaccurate results.
void	setMessage(String msg) Optional message.

Methods inherited from class java.lang.Object

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

Method Detail

setMessage

public void setMessage(String msg)

Optional message. It can inform the user about result, e.g. that result can be incomplete etc.

Parameters:

msg - message

addFile

public void addFile(FileObject file)

Adds a file into the result When the file is under processed SourceGroup relative path is displayed in the dialog. If the file is not under SourceGroup absolute path is used. Never add a file owned by other SourceGroup.

Parameters:

file - The file to be added into result

addFileDescriptor

public void addFileDescriptor(FileDescriptor desc)

Adds a FileDescriptor into the result

Parameters:

desc - The FileDescriptor to be added into result

pendingResult

public void pendingResult()

Notify caller that a provider should be called again because of incomplete or inaccurate results. Method can be used when long running task blocks the provider to complete the data.