Package org.eclipse.jface.text

Interface ISynchronizable

All Known Subinterfaces:
IAnnotationMap
All Known Implementing Classes:
AbstractMarkerAnnotationModel, AnnotationModel, ProjectionAnnotationModel, ResourceMarkerAnnotationModel
public interface ISynchronizable
Interface for text related objects which may be used in the multi-threaded context and thus must provide a way to prevent concurrent access and manipulation.

In order to reduce the probability of dead locks clients should synchronize their access to these objects by using the provided lock object rather than the object itself.

Managing objects can use the setLockObject method in order to synchronize whole sets of objects.

Since:
3.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getLockObject()
    Returns the lock object or null if there is none.
    void
    setLockObject(Object lockObject)
    Sets the lock object for this object.

  • Method Details

    • setLockObject

      void setLockObject(Object lockObject)
      Sets the lock object for this object. If the lock object is not null subsequent calls to specified methods of this object are synchronized on this lock object. Which methods are synchronized is specified by the implementer.

      You should not override an existing lock object unless you own that lock object yourself. Use the existing lock object instead.

      Parameters:
      lockObject - the lock object. May be null.

    • getLockObject

      Object getLockObject()
      Returns the lock object or null if there is none. Clients should use the lock object in order to synchronize concurrent access to the implementer.
      Returns:
      the lock object or null