Class AbstractDocumentProvider
- java.lang.Object
-
- org.eclipse.ui.texteditor.AbstractDocumentProvider
-
- All Implemented Interfaces:
IDocumentProvider,IDocumentProviderExtension,IDocumentProviderExtension2,IDocumentProviderExtension3,IDocumentProviderExtension4,IDocumentProviderExtension5
- Direct Known Subclasses:
StorageDocumentProvider
public abstract class AbstractDocumentProvider extends Object implements IDocumentProvider, IDocumentProviderExtension, IDocumentProviderExtension2, IDocumentProviderExtension3, IDocumentProviderExtension4, IDocumentProviderExtension5
An abstract implementation of a sharable document provider.Subclasses must implement
createDocument,createAnnotationModel, anddoSaveDocument.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classAbstractDocumentProvider.DocumentProviderOperationOperation created by the document provider and to be executed by the providers runnable context.protected classAbstractDocumentProvider.ElementInfoCollection of all information managed for a connected element.
-
Field Summary
Fields Modifier and Type Field Description protected static booleanPR10806_UC5_ENABLEDEnables a certain behavior.protected static booleanPR14469_ENABLEDEnables a certain behavior.protected static IStatusSTATUS_ERRORConstant for representing the error status.protected static IStatusSTATUS_OKDeprecated.As of 3.6, replaced byStatus.OK_STATUS
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractDocumentProvider()Creates a new document provider.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaboutToChange(Object element)TheAbstractDocumentProviderimplementation of thisIDocumentProvidermethod does nothing.voidaddElementStateListener(IElementStateListener listener)Adds the given element state listener to this document provider.protected voidaddUnchangedElementListeners(Object element, AbstractDocumentProvider.ElementInfo info)Called on initial creation and when the dirty state of the element changes tofalse.booleancanSaveDocument(Object element)Returns whether the document provided for the given element differs from its original state which would required that it be saved.voidchanged(Object element)TheAbstractDocumentProviderimplementation of thisIDocumentProvidermethod does nothing.voidconnect(Object element)Connects the given element to this document provider.protected voidconnected()This hook method is called when this provider starts managing documents for elements.protected abstract IAnnotationModelcreateAnnotationModel(Object element)Creates an annotation model for the given element.protected abstract IDocumentcreateDocument(Object element)Creates the document for the given element.protected AbstractDocumentProvider.ElementInfocreateElementInfo(Object element)Creates a new element info object for the given element.voiddisconnect(Object element)Disconnects the given element from this document provider.protected voiddisconnected()This hook method is called when this provider stops managing documents for element.protected voiddisposeElementInfo(Object element, AbstractDocumentProvider.ElementInfo info)Disposes of the given element info object.protected voiddoResetDocument(Object element, IProgressMonitor monitor)Executes the actual work of reseting the given elements document.protected abstract voiddoSaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)Performs the actual work of saving the given document provided for the given element.protected voiddoSynchronize(Object element, IProgressMonitor monitor)Performs the actual work of synchronizing the given element.protected voiddoUpdateStateCache(Object element)Hook method for updating the state of the given element.protected voiddoValidateState(Object element, Object computationContext)Hook method for validating the state of the given element.protected voidexecuteOperation(AbstractDocumentProvider.DocumentProviderOperation operation, IProgressMonitor monitor)Executes the given operation in the providers runnable context.protected voidfireElementContentAboutToBeReplaced(Object element)Informs all registered element state listeners about an impending replace of the given element's content.protected voidfireElementContentReplaced(Object element)Informs all registered element state listeners about the just-completed replace of the given element's content.protected voidfireElementDeleted(Object element)Informs all registered element state listeners about the deletion of the given element.protected voidfireElementDirtyStateChanged(Object element, boolean isDirty)Informs all registered element state listeners about a change in the dirty state of the given element.protected voidfireElementMoved(Object originalElement, Object movedElement)Informs all registered element state listeners about a move.protected voidfireElementStateChangeFailed(Object element)Informs all registered element state listeners about the failed state change of the elementprotected voidfireElementStateChanging(Object element)Informs all registered element state listeners about the current state change of the elementprotected voidfireElementStateValidationChanged(Object element, boolean isStateValidated)Informs all registered element state listeners about a change in the state validation of the given element.IAnnotationModelgetAnnotationModel(Object element)Returns the annotation model for the given element.protected Iterator<Object>getConnectedElements()Enumerates the elements connected via this document provider.IContentTypegetContentType(Object element)Returns the content type of for the given element ornullif none could be determined.IDocumentgetDocument(Object element)Returns the document for the given element.protected AbstractDocumentProvider.ElementInfogetElementInfo(Object element)Returns the element info object for the given element.longgetModificationStamp(Object element)Returns the modification stamp of the given element.protected abstract IRunnableContextgetOperationRunner(IProgressMonitor monitor)Returns the runnable context for this document provider.IProgressMonitorgetProgressMonitor()Returns this providers progress monitor.protected ISchedulingRulegetResetRule(Object element)Returns the scheduling rule required for executingreseton the given element.protected ISchedulingRulegetSaveRule(Object element)Returns the scheduling rule required for executingsaveon the given element.IStatusgetStatus(Object element)Returns the status of the given element.longgetSynchronizationStamp(Object element)Returns the time stamp of the last synchronization of the given element and its provided document.protected ISchedulingRulegetSynchronizeRule(Object element)Returns the scheduling rule required for executingsynchronizeon the given element.protected ISchedulingRulegetValidateStateRule(Object element)Returns the scheduling rule required for executingvalidateStateon the given element.protected booleaninvalidatesState(Object element, boolean wasReadOnly)Returns whether the state of the element must be invalidated given its previous read-only state.booleanisDeleted(Object element)Returns whether the given element has been deleted.booleanisModifiable(Object element)Returns whether the document provider thinks that the given element can persistently be modified.booleanisNotSynchronizedException(Object element, CoreException ex)Tells whether the given core exception is exactly the exception which is thrown for a non-synchronized element.booleanisReadOnly(Object element)Returns whether the document provider thinks that the given element is read-only.booleanisStateValidated(Object element)Returns whethervalidateStatehas been called for the given element since the element's state has potentially been invalidated.booleanisSynchronized(Object element)Returns whether the information provided for the given element is in sync with the element.booleanmustSaveDocument(Object element)Returns whether the document provided for the given element must be saved.voidremoveElementStateListener(IElementStateListener listener)Removes the given element state listener from this document provider.protected voidremoveUnchangedElementListeners(Object element, AbstractDocumentProvider.ElementInfo info)Called when the given element gets dirty.voidresetDocument(Object element)Resets the given element's document to its last saved state.voidsaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)Saves the given document provided for the given element.voidsetCanSaveDocument(Object element)Marks the document managed for the given element as savable.voidsetProgressMonitor(IProgressMonitor progressMonitor)Sets this providers progress monitor.voidsynchronize(Object element)Synchronizes the document provided for the given element with the given element.voidupdateStateCache(Object element)Updates the state cache for the given element.voidvalidateState(Object element, Object computationContext)Validates the state of the given element.
-
-
-
Field Detail
-
PR10806_UC5_ENABLED
protected static final boolean PR10806_UC5_ENABLED
Enables a certain behavior. Indicates whether this provider should behave as described in use case 5 of http://bugs.eclipse.org/bugs/show_bug.cgi?id=10806. Current value:truesince 3.0- Since:
- 2.0
- See Also:
- Constant Field Values
-
PR14469_ENABLED
protected static final boolean PR14469_ENABLED
Enables a certain behavior. Indicates whether this provider should behave as described in http://bugs.eclipse.org/bugs/show_bug.cgi?id=14469 Notes: This contradictsPR10806_UC5_ENABLED. Current value:falsesince 3.0- Since:
- 2.0
- See Also:
- Constant Field Values
-
STATUS_OK
@Deprecated protected static final IStatus STATUS_OK
Deprecated.As of 3.6, replaced byStatus.OK_STATUSConstant for representing the OK status. This is considered a value object.- Since:
- 2.0
-
STATUS_ERROR
protected static final IStatus STATUS_ERROR
Constant for representing the error status. This is considered a value object.- Since:
- 2.0
-
-
Method Detail
-
createDocument
protected abstract IDocument createDocument(Object element) throws CoreException
Creates the document for the given element.Subclasses must implement this method.
- Parameters:
element- the element- Returns:
- the document
- Throws:
CoreException- if the document could not be created
-
createAnnotationModel
protected abstract IAnnotationModel createAnnotationModel(Object element) throws CoreException
Creates an annotation model for the given element.Subclasses must implement this method.
- Parameters:
element- the element- Returns:
- the annotation model or
nullif none - Throws:
CoreException- if the annotation model could not be created
-
doSaveDocument
protected abstract void doSaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) throws CoreException
Performs the actual work of saving the given document provided for the given element.Subclasses must implement this method.
- Parameters:
monitor- a progress monitor to report progress and request cancelationelement- the elementdocument- the documentoverwrite- indicates whether an overwrite should happen if necessary- Throws:
CoreException- if document could not be stored to the given element
-
getOperationRunner
protected abstract IRunnableContext getOperationRunner(IProgressMonitor monitor)
Returns the runnable context for this document provider.- Parameters:
monitor- a progress monitor to track the operation- Returns:
- the runnable context for this document provider
- Since:
- 3.0
-
getSynchronizeRule
protected ISchedulingRule getSynchronizeRule(Object element)
Returns the scheduling rule required for executingsynchronizeon the given element. This default implementation returnsnull.- Parameters:
element- the element- Returns:
- the scheduling rule for
synchronize - Since:
- 3.0
-
getValidateStateRule
protected ISchedulingRule getValidateStateRule(Object element)
Returns the scheduling rule required for executingvalidateStateon the given element. This default implementation returnsnull.- Parameters:
element- the element- Returns:
- the scheduling rule for
validateState - Since:
- 3.0
-
getSaveRule
protected ISchedulingRule getSaveRule(Object element)
Returns the scheduling rule required for executingsaveon the given element. This default implementation returnsnull.- Parameters:
element- the element- Returns:
- the scheduling rule for
save - Since:
- 3.0
-
getResetRule
protected ISchedulingRule getResetRule(Object element)
Returns the scheduling rule required for executingreseton the given element. This default implementation returnsnull.- Parameters:
element- the element- Returns:
- the scheduling rule for
reset - Since:
- 3.0
-
getElementInfo
protected AbstractDocumentProvider.ElementInfo getElementInfo(Object element)
Returns the element info object for the given element.- Parameters:
element- the element- Returns:
- the element info object, or
nullif none
-
createElementInfo
protected AbstractDocumentProvider.ElementInfo createElementInfo(Object element) throws CoreException
Creates a new element info object for the given element.This method is called from
connectwhen an element info needs to be created. TheAbstractDocumentProviderimplementation of this method returns a new element info object whose document and annotation model are the values ofcreateDocument(element)andcreateAnnotationModel(element), respectively. Subclasses may override.- Parameters:
element- the element- Returns:
- a new element info object
- Throws:
CoreException- if the document or annotation model could not be created
-
disposeElementInfo
protected void disposeElementInfo(Object element, AbstractDocumentProvider.ElementInfo info)
Disposes of the given element info object.This method is called when an element info is disposed. The
AbstractDocumentProviderimplementation of this method does nothing. Subclasses may reimplement.- Parameters:
element- the elementinfo- the element info object
-
addUnchangedElementListeners
protected void addUnchangedElementListeners(Object element, AbstractDocumentProvider.ElementInfo info)
Called on initial creation and when the dirty state of the element changes tofalse. Adds all listeners which must be active as long as the element is not dirty. This method is called beforefireElementDirtyStateChangedorfireElementContentReplacedis called. Subclasses may extend.- Parameters:
element- the elementinfo- the element info object
-
removeUnchangedElementListeners
protected void removeUnchangedElementListeners(Object element, AbstractDocumentProvider.ElementInfo info)
Called when the given element gets dirty. Removes all listeners which must be active only when the element is not dirty. This method is called beforefireElementDirtyStateChangedorfireElementContentReplacedis called. Subclasses may extend.- Parameters:
element- the elementinfo- the element info object
-
getConnectedElements
protected Iterator<Object> getConnectedElements()
Enumerates the elements connected via this document provider.- Returns:
- the list of elements
-
connect
public final void connect(Object element) throws CoreException
Description copied from interface:IDocumentProviderConnects the given element to this document provider. This tells the provider that caller of this method is interested to work with the document provided for the given domain model element. By counting the invocations of this method anddisconnect(Object)this provider can assume to know the correct number of clients working with the document provided for that domain model element.The given element must not be
null.- Specified by:
connectin interfaceIDocumentProvider- Parameters:
element- the element- Throws:
CoreException- if the textual representation or the annotation model of the element could not be created
-
connected
protected void connected()
This hook method is called when this provider starts managing documents for elements. I.e. it is called when the first element gets connected to this provider. Subclasses may extend.- Since:
- 2.0
-
disconnect
public final void disconnect(Object element)
Description copied from interface:IDocumentProviderDisconnects the given element from this document provider. This tells the provider that the caller of this method is no longer interested in working with the document provided for the given domain model element. By counting the invocations ofconnect(Object)and of this method this provider can assume to know the correct number of clients working with the document provided for that domain model element.The given element must not be
null.- Specified by:
disconnectin interfaceIDocumentProvider- Parameters:
element- the element
-
disconnected
protected void disconnected()
This hook method is called when this provider stops managing documents for element. I.e. it is called when the last element gets disconnected from this provider. Subclasses may extend.- Since:
- 2.0
-
getDocument
public IDocument getDocument(Object element)
Description copied from interface:IDocumentProviderReturns the document for the given element. Usually the document contains a textual presentation of the content of the element, or is the element itself.- Specified by:
getDocumentin interfaceIDocumentProvider- Parameters:
element- the element, ornull- Returns:
- the document, or
nullif none
-
mustSaveDocument
public boolean mustSaveDocument(Object element)
Description copied from interface:IDocumentProviderReturns whether the document provided for the given element must be saved.- Specified by:
mustSaveDocumentin interfaceIDocumentProvider- Parameters:
element- the element, ornull- Returns:
trueif the document must be saved, andfalseotherwise (including the element isnull)
-
getAnnotationModel
public IAnnotationModel getAnnotationModel(Object element)
Description copied from interface:IDocumentProviderReturns the annotation model for the given element.- Specified by:
getAnnotationModelin interfaceIDocumentProvider- Parameters:
element- the element, ornull- Returns:
- the annotation model, or
nullif none
-
canSaveDocument
public boolean canSaveDocument(Object element)
Description copied from interface:IDocumentProviderReturns whether the document provided for the given element differs from its original state which would required that it be saved.- Specified by:
canSaveDocumentin interfaceIDocumentProvider- Parameters:
element- the element, ornull- Returns:
trueif the document can be saved, andfalseotherwise (including the element isnull)
-
doResetDocument
protected void doResetDocument(Object element, IProgressMonitor monitor) throws CoreException
Executes the actual work of reseting the given elements document.- Parameters:
element- the elementmonitor- the progress monitor- Throws:
CoreException- if resetting fails- Since:
- 3.0
-
executeOperation
protected void executeOperation(AbstractDocumentProvider.DocumentProviderOperation operation, IProgressMonitor monitor) throws CoreException
Executes the given operation in the providers runnable context.- Parameters:
operation- the operation to be executesmonitor- the progress monitor- Throws:
CoreException- the operation's core exception- Since:
- 3.0
-
resetDocument
public final void resetDocument(Object element) throws CoreException
Description copied from interface:IDocumentProviderResets the given element's document to its last saved state. Element state listeners are notified both before (elementContentAboutToBeReplaced) and after (elementContentReplaced) the content is changed.- Specified by:
resetDocumentin interfaceIDocumentProvider- Parameters:
element- the element, ornull- Throws:
CoreException- if document could not be reset for the given element
-
saveDocument
public final void saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) throws CoreException
Description copied from interface:IDocumentProviderSaves the given document provided for the given element.- Specified by:
saveDocumentin interfaceIDocumentProvider- Parameters:
monitor- a progress monitor to report progress and request cancelationelement- the element, ornulldocument- the documentoverwrite- indicates whether overwrite should be performed while saving the given element if necessary- Throws:
CoreException- if document could not be stored to the given element
-
aboutToChange
public void aboutToChange(Object element)
TheAbstractDocumentProviderimplementation of thisIDocumentProvidermethod does nothing. Subclasses may reimplement.- Specified by:
aboutToChangein interfaceIDocumentProvider- Parameters:
element- the element
-
changed
public void changed(Object element)
TheAbstractDocumentProviderimplementation of thisIDocumentProvidermethod does nothing. Subclasses may reimplement.- Specified by:
changedin interfaceIDocumentProvider- Parameters:
element- the element
-
addElementStateListener
public void addElementStateListener(IElementStateListener listener)
Description copied from interface:IDocumentProviderAdds the given element state listener to this document provider. Has no effect if an identical listener is already registered.- Specified by:
addElementStateListenerin interfaceIDocumentProvider- Parameters:
listener- the listener
-
removeElementStateListener
public void removeElementStateListener(IElementStateListener listener)
Description copied from interface:IDocumentProviderRemoves the given element state listener from this document provider. Has no effect if an identical listener is not registered.- Specified by:
removeElementStateListenerin interfaceIDocumentProvider- Parameters:
listener- the listener
-
fireElementDirtyStateChanged
protected void fireElementDirtyStateChanged(Object element, boolean isDirty)
Informs all registered element state listeners about a change in the dirty state of the given element.- Parameters:
element- the elementisDirty- the new dirty state- See Also:
IElementStateListener.elementDirtyStateChanged(Object, boolean)
-
fireElementContentAboutToBeReplaced
protected void fireElementContentAboutToBeReplaced(Object element)
Informs all registered element state listeners about an impending replace of the given element's content.- Parameters:
element- the element- See Also:
IElementStateListener.elementContentAboutToBeReplaced(Object)
-
fireElementContentReplaced
protected void fireElementContentReplaced(Object element)
Informs all registered element state listeners about the just-completed replace of the given element's content.- Parameters:
element- the element- See Also:
IElementStateListener.elementContentReplaced(Object)
-
fireElementDeleted
protected void fireElementDeleted(Object element)
Informs all registered element state listeners about the deletion of the given element.- Parameters:
element- the element- See Also:
IElementStateListener.elementDeleted(Object)
-
fireElementMoved
protected void fireElementMoved(Object originalElement, Object movedElement)
Informs all registered element state listeners about a move.- Parameters:
originalElement- the element before the movemovedElement- the element after the move- See Also:
IElementStateListener.elementMoved(Object, Object)
-
getModificationStamp
public long getModificationStamp(Object element)
Description copied from interface:IDocumentProviderReturns the modification stamp of the given element.- Specified by:
getModificationStampin interfaceIDocumentProvider- Parameters:
element- the element- Returns:
- the modification stamp of the given element
-
getSynchronizationStamp
public long getSynchronizationStamp(Object element)
Description copied from interface:IDocumentProviderReturns the time stamp of the last synchronization of the given element and its provided document.- Specified by:
getSynchronizationStampin interfaceIDocumentProvider- Parameters:
element- the element- Returns:
- the synchronization stamp of the given element
-
isDeleted
public boolean isDeleted(Object element)
Description copied from interface:IDocumentProviderReturns whether the given element has been deleted.- Specified by:
isDeletedin interfaceIDocumentProvider- Parameters:
element- the element- Returns:
trueif the element has been deleted
-
isReadOnly
public boolean isReadOnly(Object element)
Description copied from interface:IDocumentProviderExtensionReturns whether the document provider thinks that the given element is read-only. If this method returnstrue,saveDocumentcould fail. This method does not say anything about the document constructed from the given element. If the given element is not connected to this document provider, the return value is undefined. Document providers are allowed to use a cache to answer this question, i.e. there can be a difference between the "real" state of the element and the return value.- Specified by:
isReadOnlyin interfaceIDocumentProviderExtension- Parameters:
element- the element- Returns:
trueif the given element is read-only,falseotherwise
-
isModifiable
public boolean isModifiable(Object element)
Description copied from interface:IDocumentProviderExtensionReturns whether the document provider thinks that the given element can persistently be modified. This is orthogonal toisReadOnlyas read-only elements may be modifiable and writable elements may not be modifiable. If the given element is not connected to this document provider, the result is undefined. Document providers are allowed to use a cache to answer this question, i.e. there can be a difference between the "real" state of the element and the return value.- Specified by:
isModifiablein interfaceIDocumentProviderExtension- Parameters:
element- the element- Returns:
trueif the given element is modifiable,falseotherwise
-
isStateValidated
public boolean isStateValidated(Object element)
Returns whethervalidateStatehas been called for the given element since the element's state has potentially been invalidated.- Specified by:
isStateValidatedin interfaceIDocumentProviderExtension- Parameters:
element- the element- Returns:
- whether
validateStatehas been called for the given element - Since:
- 2.0
-
doValidateState
protected void doValidateState(Object element, Object computationContext) throws CoreException
Hook method for validating the state of the given element. Must not take care of cache updating etc. Default implementation is empty.- Parameters:
element- the elementcomputationContext- the context in which validation happens- Throws:
CoreException- in case validation fails- Since:
- 2.0
-
validateState
public void validateState(Object element, Object computationContext) throws CoreException
Description copied from interface:IDocumentProviderExtensionValidates the state of the given element. This method may change the "real" state of the element. If using, it also updates the internal caches, so that this method may also change the results returned byisReadOnlyandisModifiable. If the given element is not connected to this document provider, the effect is undefined.- Specified by:
validateStatein interfaceIDocumentProviderExtension- Parameters:
element- the elementcomputationContext- the context in which the computation is performed, e.g., a SWT shell- Throws:
CoreException- if validating fails
-
doUpdateStateCache
protected void doUpdateStateCache(Object element) throws CoreException
Hook method for updating the state of the given element. Default implementation is empty.- Parameters:
element- the element- Throws:
CoreException- in case state cache updating fails- Since:
- 2.0
-
invalidatesState
protected boolean invalidatesState(Object element, boolean wasReadOnly)
Returns whether the state of the element must be invalidated given its previous read-only state.- Parameters:
element- the elementwasReadOnly- the previous read-only state- Returns:
trueif the state of the given element must be invalidated- Since:
- 2.0
-
updateStateCache
public final void updateStateCache(Object element) throws CoreException
Description copied from interface:IDocumentProviderExtensionUpdates the state cache for the given element. This method may change the result returned byisReadOnlyandisModifiable. If the given element is not connected to this document provider, the effect is undefined.- Specified by:
updateStateCachein interfaceIDocumentProviderExtension- Parameters:
element- the element- Throws:
CoreException- if validating fails
-
setCanSaveDocument
public void setCanSaveDocument(Object element)
Description copied from interface:IDocumentProviderExtensionMarks the document managed for the given element as savable. I.e.canBeSaved(element)will returntrueafterwards.- Specified by:
setCanSaveDocumentin interfaceIDocumentProviderExtension- Parameters:
element- the element
-
fireElementStateValidationChanged
protected void fireElementStateValidationChanged(Object element, boolean isStateValidated)
Informs all registered element state listeners about a change in the state validation of the given element.- Parameters:
element- the elementisStateValidated- the flag indicating whether state validation is done- Since:
- 2.0
- See Also:
IElementStateListenerExtension.elementStateValidationChanged(Object, boolean)
-
fireElementStateChanging
protected void fireElementStateChanging(Object element)
Informs all registered element state listeners about the current state change of the element- Parameters:
element- the element- Since:
- 2.0
- See Also:
IElementStateListenerExtension.elementStateChanging(Object)
-
fireElementStateChangeFailed
protected void fireElementStateChangeFailed(Object element)
Informs all registered element state listeners about the failed state change of the element- Parameters:
element- the element- Since:
- 2.0
- See Also:
IElementStateListenerExtension.elementStateChangeFailed(Object)
-
getStatus
public IStatus getStatus(Object element)
Description copied from interface:IDocumentProviderExtensionReturns the status of the given element.- Specified by:
getStatusin interfaceIDocumentProviderExtension- Parameters:
element- the element- Returns:
- the status of the given element
-
doSynchronize
protected void doSynchronize(Object element, IProgressMonitor monitor) throws CoreException
Performs the actual work of synchronizing the given element.- Parameters:
element- the elementmonitor- the progress monitor- Throws:
CoreException- in the case that synchronization fails- Since:
- 3.0
-
synchronize
public final void synchronize(Object element) throws CoreException
Description copied from interface:IDocumentProviderExtensionSynchronizes the document provided for the given element with the given element. After that callgetSynchronizationTimeStampandgetModificationTimeStampreturn the same value.- Specified by:
synchronizein interfaceIDocumentProviderExtension- Parameters:
element- the element- Throws:
CoreException- if the synchronization could not be performed
-
getProgressMonitor
public IProgressMonitor getProgressMonitor()
Description copied from interface:IDocumentProviderExtension2Returns this providers progress monitor.- Specified by:
getProgressMonitorin interfaceIDocumentProviderExtension2- Returns:
- IProgressMonitor
-
setProgressMonitor
public void setProgressMonitor(IProgressMonitor progressMonitor)
Description copied from interface:IDocumentProviderExtension2Sets this providers progress monitor.- Specified by:
setProgressMonitorin interfaceIDocumentProviderExtension2- Parameters:
progressMonitor- the progress monitor
-
isSynchronized
public boolean isSynchronized(Object element)
Description copied from interface:IDocumentProviderExtension3Returns whether the information provided for the given element is in sync with the element.- Specified by:
isSynchronizedin interfaceIDocumentProviderExtension3- Parameters:
element- the element- Returns:
trueif the information is in sync with the element,falseotherwise
-
isNotSynchronizedException
public boolean isNotSynchronizedException(Object element, CoreException ex)
Description copied from interface:IDocumentProviderExtension5Tells whether the given core exception is exactly the exception which is thrown for a non-synchronized element.- Specified by:
isNotSynchronizedExceptionin interfaceIDocumentProviderExtension5- Parameters:
element- the elementex- the core exception- Returns:
trueiff the given core exception is exactly the exception which is thrown for a non-synchronized element
-
getContentType
public IContentType getContentType(Object element) throws CoreException
Description copied from interface:IDocumentProviderExtension4Returns the content type of for the given element ornullif none could be determined. If the element's document can be saved, the returned content type is determined by the document's current content.- Specified by:
getContentTypein interfaceIDocumentProviderExtension4- Parameters:
element- the element- Returns:
- the content type or
null - Throws:
CoreException- if reading or accessing the underlying store fails
-
-