Class SharedDocumentAdapterWrapper
java.lang.Object
org.eclipse.compare.structuremergeviewer.SharedDocumentAdapterWrapper
- All Implemented Interfaces:
ISharedDocumentAdapter
An implementation of
ISharedDocumentAdapter
that wraps another
shared document adapter.
Clients may subclass this class.
- Since:
- 3.3
-
Constructor Summary
ConstructorDescriptionSharedDocumentAdapterWrapper
(ISharedDocumentAdapter wrappedAdapter) Creates a shared document adapter that wraps the given adapter. -
Method Summary
Modifier and TypeMethodDescriptionvoid
connect
(IDocumentProvider provider, IEditorInput documentKey) Connect the given element to its document provider.void
disconnect
(Object element) A helper disconnect method that looks up the appropriate key (usingISharedDocumentAdapter.getDocumentKey(Object)
and the appropriate provider and callsISharedDocumentAdapter.disconnect(IDocumentProvider, IEditorInput)
.void
disconnect
(IDocumentProvider provider, IEditorInput documentKey) Disconnect the element from the document provider.void
flushDocument
(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite) Flush the contents of the given document into the typed element that provided the document.static ISharedDocumentAdapter
getAdapter
(Object element) Helper method that returns the shared document adapter for the given typed element ornull
if there isn't one.getDocumentKey
(Object element) Return the object that is to be used as the key for retrieving the appropriateIDocumentProvider
from theDocumentProviderRegistry
and for obtaining the sharedIDocument
from the document provider.final ISharedDocumentAdapter
Returns the wrapped adapter.
-
Constructor Details
-
Method Details
-
getAdapter
Helper method that returns the shared document adapter for the given typed element ornull
if there isn't one.- Parameters:
element
- the typed element- Returns:
- the shared document adapter for the given typed element
or
null
-
connect
Description copied from interface:ISharedDocumentAdapter
Connect the given element to its document provider. All connections must be performed through this adapter so that the adapter can track whether it is connected or not.- Specified by:
connect
in interfaceISharedDocumentAdapter
- Parameters:
provider
- the document providerdocumentKey
- the element's key returned fromISharedDocumentAdapter.getDocumentKey(Object)
- Throws:
CoreException
- if connection was not possible- See Also:
-
disconnect
Description copied from interface:ISharedDocumentAdapter
Disconnect the element from the document provider. All connects and disconnects must occur through the adapter so that the adapter can track whether it is connected or not.- Specified by:
disconnect
in interfaceISharedDocumentAdapter
- Parameters:
provider
- the document providerdocumentKey
- the element's key returned fromISharedDocumentAdapter.getDocumentKey(Object)
- See Also:
-
getDocumentKey
Description copied from interface:ISharedDocumentAdapter
Return the object that is to be used as the key for retrieving the appropriateIDocumentProvider
from theDocumentProviderRegistry
and for obtaining the sharedIDocument
from the document provider. Returnsnull
if the element does not have a shared document.- Specified by:
getDocumentKey
in interfaceISharedDocumentAdapter
- Parameters:
element
- the element being queried for a shared document- Returns:
- the object that acts as the key to obtain a document provider and
document or
null
-
flushDocument
public void flushDocument(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite) throws CoreException Description copied from interface:ISharedDocumentAdapter
Flush the contents of the given document into the typed element that provided the document. This method is invoked by the Compare framework classes when a request to flush the viewers has been made. It is up to the implementor to decide whether the changes in the buffer should be saved to disk at the time of the flush or buffered to be saved at a later time.- Specified by:
flushDocument
in interfaceISharedDocumentAdapter
- Parameters:
provider
- the document providerdocumentKey
- the element's key returned fromISharedDocumentAdapter.getDocumentKey(Object)
document
- 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- See Also:
-
getWrappedAdapter
Returns the wrapped adapter.- Returns:
- the wrapped adapter
-
disconnect
Description copied from interface:ISharedDocumentAdapter
A helper disconnect method that looks up the appropriate key (usingISharedDocumentAdapter.getDocumentKey(Object)
and the appropriate provider and callsISharedDocumentAdapter.disconnect(IDocumentProvider, IEditorInput)
.- Specified by:
disconnect
in interfaceISharedDocumentAdapter
- Parameters:
element
- the element that was used to previously connect to a document- See Also:
-