oracle.ide.status

Class StatusManager

java.lang.Object

oracle.ide.status.StatusManager

public class StatusManager
extends java.lang.Object

A manager of the status of the files managed by the IDE.

Clients should add a listener for each file for which they need to follow the status (the same listener may be used for any number of files). The status manager will track status for any file with a listener.

Method Summary

Methods

Modifier and Type	Method and Description
IssueList	addAssistListener(java.net.URL file, Project project, Workspace workspace, AssistListener listener, View view) Adds an assist listener to a file.
IssueList	addIssueListener(java.net.URL file, Project project, Workspace workspace, IssueListener listener, View view) Adds an issue listener to a file.
boolean	addStalenessListener(java.net.URL file, Project project, Workspace workspace, StalenessListener listener) Adds a staleness listener to a file.
Status	addStatusListener(java.net.URL file, Project project, Workspace workspace, StatusListener listener) Adds a status listener to a file.
static StatusManager	getStatusManager() Gets the status manager.
void	pause(boolean cancel) Pauses the StatusManager executor, if not already paused.
void	removeAssistListener(AssistListener listener) Removes an assist listener from all files.
void	removeAssistListener(java.net.URL file, Project project, Workspace workspace, AssistListener listener) Removes an assist listener from a file.
void	removeIssueListener(IssueListener listener) Removes an issue listener from all files.
void	removeIssueListener(java.net.URL file, Project project, Workspace workspace, IssueListener listener) Removes an issue listener from a file.
void	removeStalenessListener(StalenessListener listener) Removes a staleness listener from all files.
void	removeStalenessListener(java.net.URL file, Project project, Workspace workspace, StalenessListener listener) Removes a staleness listener from a file.
void	removeStatusListener(StatusListener listener) Removes a status listener from all files.
void	removeStatusListener(java.net.URL file, Project project, Workspace workspace, StatusListener listener) Removes a status listener from a file.
void	resume() Resumes the StatusManager executor, if only one pause(boolean) has not been paired with a resume().

Methods inherited from class java.lang.Object

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

Method Detail

getStatusManager

public static StatusManager getStatusManager()

Gets the status manager.

addStatusListener

public Status addStatusListener(java.net.URL file,
                       Project project,
                       Workspace workspace,
                       StatusListener listener)

Adds a status listener to a file. A status listener, unlike an issue or assist listener, does not have access to the list of issues found in the file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - A listener for changes in the status of the file.

Returns:

the current status of the file (possibly stale).

removeStatusListener

public void removeStatusListener(java.net.URL file,
                        Project project,
                        Workspace workspace,
                        StatusListener listener)

Removes a status listener from a file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - The listener to remove.

removeStatusListener

public void removeStatusListener(StatusListener listener)

Removes a status listener from all files.

Parameters:

listener - The listener to remove.

addIssueListener

public IssueList addIssueListener(java.net.URL file,
                         Project project,
                         Workspace workspace,
                         IssueListener listener,
                         View view)

Adds an issue listener to a file. An issue listener, unlike a status listener, does have access to the list of issues found in the file; unlike an assist listener, it does not have access to the assists in a file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - A listener for changes in the status or issues of the file.

view - The view depending on this listener, if any.

Returns:

the current issues of the file (possibly stale).

removeIssueListener

public void removeIssueListener(java.net.URL file,
                       Project project,
                       Workspace workspace,
                       IssueListener listener)

Removes an issue listener from a file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - The listener to remove.

removeIssueListener

public void removeIssueListener(IssueListener listener)

Removes an issue listener from all files.

Parameters:

listener - The listener to remove.

addAssistListener

public IssueList addAssistListener(java.net.URL file,
                          Project project,
                          Workspace workspace,
                          AssistListener listener,
                          View view)

Adds an assist listener to a file. An assist listener, unlike a status listener, does have access to the list of issues found in the file; and, unlike an issue listener, it does have access to the assists in a file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - A listener for changes in the status or issues of the file.

view - The view depending on this listener, if any.

Returns:

the current issues and assists of the file (possibly stale).

removeAssistListener

public void removeAssistListener(java.net.URL file,
                        Project project,
                        Workspace workspace,
                        AssistListener listener)

Removes an assist listener from a file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - The listener to remove.

removeAssistListener

public void removeAssistListener(AssistListener listener)

Removes an assist listener from all files.

Parameters:

listener - The listener to remove.

addStalenessListener

public boolean addStalenessListener(java.net.URL file,
                           Project project,
                           Workspace workspace,
                           StalenessListener listener)

Adds a staleness listener to a file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - A listener for staleness of the status of the file.

Returns:

whether the file is currently stale.

removeStalenessListener

public void removeStalenessListener(java.net.URL file,
                           Project project,
                           Workspace workspace,
                           StalenessListener listener)

Removes a staleness listener from a file.

Parameters:

file - The URL of the file.

project - The project containing the file, or null if the file is a project or workspace.

workspace - The workspace containing the file, or null if the file is a workspace.

listener - The listener to remove.

removeStalenessListener

public void removeStalenessListener(StalenessListener listener)

Removes a staleness listener from all files.

Parameters:

listener - The listener to remove.

pause

public void pause(boolean cancel)

Pauses the StatusManager executor, if not already paused. Each invocation of pause(boolean) must be paired with a subsequent invocation of resume(). pause(boolean)/resume() pairs may be nested.

Parameters:

cancel - whether to cancel tasks currently executing.

resume

public void resume()

Resumes the StatusManager executor, if only one pause(boolean) has not been paired with a resume(). Ignored if no pause(boolean)s are unpaired.