org.eclipse.sphinx.platform.resources

Class MarkerJob

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.core.internal.jobs.InternalJob

org.eclipse.core.runtime.jobs.Job

org.eclipse.core.internal.resources.InternalWorkspaceJob

org.eclipse.core.resources.WorkspaceJob

org.eclipse.sphinx.platform.resources.MarkerJob

All Implemented Interfaces:

java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

public class MarkerJob
extends org.eclipse.core.resources.WorkspaceJob

A job which can be used to asynchronously create and delete markers.

The job is useful to avoid deadlocks related to the global workspace lock which is needed to manipulate resource markers.

The job maintains an internal queue of marker manipulation tasks when the job gets executed this queue will be processed. To execute the job asynchronously use the schedule method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MarkerJob.CreateMarkerTask
protected static class	MarkerJob.DeleteMarkerTask
protected static class	MarkerJob.MarkerTask

Field Summary

Fields

Modifier and Type	Field and Description
static MarkerJob	INSTANCE Singleton instance of marker job that can be used to manipulate resource markers asynchronously without risking to run into deadlocks.
protected java.util.Queue<MarkerJob.MarkerTask>	taskQueue

Fields inherited from class org.eclipse.core.runtime.jobs.Job

ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING

Fields inherited from class org.eclipse.core.internal.jobs.InternalJob

manager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MarkerJob() Protected constructor for the singleton pattern that prevents from instantiation by clients.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCreateMarkerTask(org.eclipse.core.resources.IResource resource, MarkerDescriptor markerDescriptor) Adds a create marker task to the internal queue.
void	addCreateMarkerTask(org.eclipse.core.resources.IResource resource, java.lang.String type, int severity, java.lang.String message) Adds a create marker task to the internal queue.
void	addCreateMarkerTask(org.eclipse.core.resources.IResource resource, java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> attributes) Adds a create marker task to the internal queue.
void	addDeleteMarkerTask(org.eclipse.core.resources.IResource resource, java.lang.String type) Adds a delete marker task to the internal queue which will delete all existing markers of the specified type.
org.eclipse.core.runtime.IStatus	runInWorkspace(org.eclipse.core.runtime.IProgressMonitor monitor) Processes the internal task queue.

Methods inherited from class org.eclipse.core.internal.resources.InternalWorkspaceJob

run

Methods inherited from class org.eclipse.core.runtime.jobs.Job

addJobChangeListener, belongsTo, cancel, canceling, create, done, getJobGroup, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, join, removeJobChangeListener, schedule, schedule, setJobGroup, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, toString, wakeUp, wakeUp, yieldRule

Methods inherited from class org.eclipse.core.internal.jobs.InternalJob

compareTo

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

INSTANCE

public static final MarkerJob INSTANCE

Singleton instance of marker job that can be used to manipulate resource markers asynchronously without risking to run into deadlocks. After queuing marker manipulations with this marker job instance it must be explicitly scheduled by the caller.

See Also:

Job.schedule()

taskQueue

protected java.util.Queue<MarkerJob.MarkerTask> taskQueue

Constructor Detail

MarkerJob

protected MarkerJob()

Protected constructor for the singleton pattern that prevents from instantiation by clients.

Method Detail

runInWorkspace

public org.eclipse.core.runtime.IStatus runInWorkspace(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                throws org.eclipse.core.runtime.CoreException

Processes the internal task queue.

Specified by:

runInWorkspace in class org.eclipse.core.resources.WorkspaceJob

Throws:

org.eclipse.core.runtime.CoreException

addCreateMarkerTask

public void addCreateMarkerTask(org.eclipse.core.resources.IResource resource,
                       java.lang.String type,
                       int severity,
                       java.lang.String message)

Adds a create marker task to the internal queue.

Parameters:

resource - the resource for which the marker will be created

type - the marker type

severity - the marker severity

severity - the marker message

See Also:

IResource.createMarker(String)

addCreateMarkerTask

public void addCreateMarkerTask(org.eclipse.core.resources.IResource resource,
                       java.lang.String type,
                       java.util.Map<java.lang.String,java.lang.Object> attributes)

Adds a create marker task to the internal queue.

Parameters:

resource - the resource for which the marker will be created

type - the marker type

attributes - marker attributes that will be passed to the newly created marker using IMarker.setAttributes(Map).

See Also:

IResource.createMarker(String)

addCreateMarkerTask

public void addCreateMarkerTask(org.eclipse.core.resources.IResource resource,
                       MarkerDescriptor markerDescriptor)

Adds a create marker task to the internal queue.

Parameters:

resource - the resource for which the marker will be created

markerDescriptor - the marker descriptor which holds the marker type and the marker attributes that will be passed to the newly created marker using IMarker.setAttributes(Map).

See Also:

IResource.createMarker(String)

addDeleteMarkerTask

public void addDeleteMarkerTask(org.eclipse.core.resources.IResource resource,
                       java.lang.String type)

Adds a delete marker task to the internal queue which will delete all existing markers of the specified type.

Parameters:

resource - the resource for which markers will be deleted

type - the marker type to delete

See Also:

IResource.deleteMarkers(String, boolean, int)