org.eclipse.ocl.xtext.base.ui.model

Class BaseCSorASDocumentProvider

java.lang.Object

org.eclipse.ui.texteditor.AbstractDocumentProvider

org.eclipse.ui.editors.text.StorageDocumentProvider

org.eclipse.ui.editors.text.FileDocumentProvider

org.eclipse.xtext.ui.editor.model.XtextDocumentProvider

org.eclipse.ocl.xtext.base.ui.model.DeferredDocumentProvider

org.eclipse.ocl.xtext.base.ui.model.BaseDocumentProvider

org.eclipse.ocl.xtext.base.ui.model.BaseCSorASDocumentProvider

All Implemented Interfaces:

org.eclipse.ui.editors.text.IStorageDocumentProvider, org.eclipse.ui.texteditor.IDocumentProvider, org.eclipse.ui.texteditor.IDocumentProviderExtension, org.eclipse.ui.texteditor.IDocumentProviderExtension2, org.eclipse.ui.texteditor.IDocumentProviderExtension3, org.eclipse.ui.texteditor.IDocumentProviderExtension4, org.eclipse.ui.texteditor.IDocumentProviderExtension5

Direct Known Subclasses:

OCLinEcoreDocumentProvider

public abstract class BaseCSorASDocumentProvider
extends BaseDocumentProvider

BaseCSorASDocumentProvider orchestrates the load and saving of optional XMI content externally while maintaining the serialised human friendly form internally.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseCSorASDocumentProvider.UnresolvedProxyDiagnostic

Nested classes/interfaces inherited from class org.eclipse.ocl.xtext.base.ui.model.DeferredDocumentProvider

DeferredDocumentProvider.DeferredSetTextJob, DeferredDocumentProvider.DeferredSetTextRunnable, DeferredDocumentProvider.DeferredSetTextUnitOfWork

Nested classes/interfaces inherited from class org.eclipse.xtext.ui.editor.model.XtextDocumentProvider

org.eclipse.xtext.ui.editor.model.XtextDocumentProvider.UnchangedElementListener, org.eclipse.xtext.ui.editor.model.XtextDocumentProvider.URIInfo

Nested classes/interfaces inherited from class org.eclipse.ui.editors.text.FileDocumentProvider

org.eclipse.ui.editors.text.FileDocumentProvider.FileInfo, org.eclipse.ui.editors.text.FileDocumentProvider.FileSynchronizer, org.eclipse.ui.editors.text.FileDocumentProvider.SafeChange

Nested classes/interfaces inherited from class org.eclipse.ui.editors.text.StorageDocumentProvider

org.eclipse.ui.editors.text.StorageDocumentProvider.StorageInfo

Nested classes/interfaces inherited from class org.eclipse.ui.texteditor.AbstractDocumentProvider

org.eclipse.ui.texteditor.AbstractDocumentProvider.DocumentProviderOperation, org.eclipse.ui.texteditor.AbstractDocumentProvider.ElementInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<org.eclipse.jface.text.IDocument,java.lang.String>	exportDelegateURIMap Delegate URI to be used when exporting, null for default.
protected java.util.Map<org.eclipse.jface.text.IDocument,java.lang.String>	loadedAsMap Representation used when loaded.
static java.lang.String	PERSIST_AS_PIVOT
static java.lang.String	PERSIST_AS_TEXT
protected java.util.Map<org.eclipse.jface.text.IDocument,java.lang.String>	saveAsMap Representation to be used when saved.
protected java.util.Map<org.eclipse.jface.text.IDocument,org.eclipse.emf.common.util.URI>	uriMap

Fields inherited from class org.eclipse.ui.editors.text.StorageDocumentProvider

DEFAULT_FILE_SIZE

Fields inherited from class org.eclipse.ui.texteditor.AbstractDocumentProvider

PR10806_UC5_ENABLED, PR14469_ENABLED, STATUS_ERROR, STATUS_OK

Constructor Summary

Constructors

Constructor and Description
BaseCSorASDocumentProvider()

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	createResettableInputStream(java.io.InputStream inputStream)
protected abstract java.lang.String	createTestDocument(org.eclipse.emf.common.util.URI uri, java.lang.String lastSegment)
protected void	diagnoseErrors(org.eclipse.xtext.resource.XtextResource xtextResource, java.lang.Exception e)
protected void	doSaveDocument(org.eclipse.core.runtime.IProgressMonitor monitor, java.lang.Object element, org.eclipse.jface.text.IDocument document, boolean overwrite)
protected abstract java.lang.String	getCScontentType()
protected abstract java.lang.String	getFileExtension()
protected void	handleElementContentChanged(org.eclipse.ui.IFileEditorInput fileEditorInput)
boolean	isDeleted(java.lang.Object element)
protected boolean	isText(java.lang.String loadedAs)
protected boolean	isXML(java.io.InputStream inputStream) Deprecated. No longer used.
protected boolean	isXML(java.io.InputStream inputStream, java.lang.String encoding)
protected void	loadResource(org.eclipse.xtext.resource.XtextResource resource, java.lang.String document, java.lang.String encoding)
protected boolean	setDocumentContent(org.eclipse.jface.text.IDocument document, org.eclipse.ui.IEditorInput editorInput, java.lang.String encoding)
protected void	setDocumentContent(org.eclipse.jface.text.IDocument document, java.io.InputStream inputStream, java.lang.String encoding)
protected void	setDocumentResource(org.eclipse.xtext.ui.editor.model.XtextDocument xtextDocument, org.eclipse.ui.IEditorInput editorInput, java.lang.String encoding)
void	setExportDelegateURI(java.lang.Object element, java.lang.String uri)
void	setPersistAs(java.lang.Object element, java.lang.String persistAs)
protected void	superDoSaveDocument(org.eclipse.core.runtime.IProgressMonitor monitor, java.lang.Object element, org.eclipse.jface.text.IDocument document, boolean overwrite)
protected void	superSetDocumentContent(org.eclipse.jface.text.IDocument document, java.io.InputStream inputStream, java.lang.String encoding)
protected void	superSetDocumentText(org.eclipse.xtext.ui.editor.model.XtextDocument document, java.lang.String displayText) Deprecated. no longer used - does nothing - retained for API compatibility

Methods inherited from class org.eclipse.ocl.xtext.base.ui.model.BaseDocumentProvider

createOCL, disconnected, getEnvironmentFactory, getOCL

Methods inherited from class org.eclipse.ocl.xtext.base.ui.model.DeferredDocumentProvider

getPleaseWaitText, scheduleDeferredSetTextJob, scheduleDeferredSetTextJob, setDocumentText

Methods inherited from class org.eclipse.xtext.ui.editor.model.XtextDocumentProvider

addUnchangedElementListeners, createAnnotationModel, createDocument, createElementInfo, createEmptyDocument, disposeElementInfo, doSynchronize, doUpdateStateCache, getEncoding, getModificationStamp, getResourceForEditorInputFactory, getStorage2UriMapper, getWorkspaceExternalEncoding, getWorkspaceOrDefaultEncoding, handleCoreException, isModifiable, isReadOnly, isSynchronized, isWorkspaceExternalEditorInput, registerAnnotationInfoProcessor, removeUnchangedElementListeners, setResourceForEditorInputFactory, updateCache

Methods inherited from class org.eclipse.ui.editors.text.FileDocumentProvider

cacheEncodingState, checkSynchronizationState, computeModificationStamp, doResetDocument, doValidateState, getContentType, getElementInfo, getOperationRunner, getPersistedEncoding, getRefreshRule, getResetRule, getSaveRule, getSynchronizationStamp, getSynchronizeRule, getValidateStateRule, handleElementDeleted, handleElementMoved, persistEncoding, readUTF8BOM, refreshFile, refreshFile, setDocumentContent

Methods inherited from class org.eclipse.ui.editors.text.StorageDocumentProvider

getDefaultEncoding, isNotSynchronizedException, setDocumentContent, setEncoding, setupDocument, updateCache

Methods inherited from class org.eclipse.ui.texteditor.AbstractDocumentProvider

aboutToChange, addElementStateListener, canSaveDocument, changed, connect, connected, disconnect, executeOperation, fireElementContentAboutToBeReplaced, fireElementContentReplaced, fireElementDeleted, fireElementDirtyStateChanged, fireElementMoved, fireElementStateChangeFailed, fireElementStateChanging, fireElementStateValidationChanged, getAnnotationModel, getConnectedElements, getDocument, getProgressMonitor, getStatus, invalidatesState, isStateValidated, mustSaveDocument, removeElementStateListener, resetDocument, saveDocument, setCanSaveDocument, setProgressMonitor, synchronize, updateStateCache, validateState

Methods inherited from class java.lang.Object

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

Field Detail

PERSIST_AS_PIVOT

public static final java.lang.String PERSIST_AS_PIVOT

See Also:

Constant Field Values

PERSIST_AS_TEXT

public static final java.lang.String PERSIST_AS_TEXT

See Also:

Constant Field Values

loadedAsMap

protected java.util.Map<org.eclipse.jface.text.IDocument,java.lang.String> loadedAsMap

Representation used when loaded.

exportDelegateURIMap

protected java.util.Map<org.eclipse.jface.text.IDocument,java.lang.String> exportDelegateURIMap

Delegate URI to be used when exporting, null for default.

saveAsMap

protected java.util.Map<org.eclipse.jface.text.IDocument,java.lang.String> saveAsMap

Representation to be used when saved.

uriMap

protected java.util.Map<org.eclipse.jface.text.IDocument,org.eclipse.emf.common.util.URI> uriMap

Constructor Detail

BaseCSorASDocumentProvider

public BaseCSorASDocumentProvider()

Method Detail

createResettableInputStream

@NonNull
public static java.io.InputStream createResettableInputStream(@NonNull
                                                                        java.io.InputStream inputStream)
                                                                 throws java.io.IOException

Throws:

java.io.IOException

diagnoseErrors

protected void diagnoseErrors(org.eclipse.xtext.resource.XtextResource xtextResource,
                              java.lang.Exception e)
                       throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

createTestDocument

@NonNull
protected abstract java.lang.String createTestDocument(@NonNull
                                                                 org.eclipse.emf.common.util.URI uri,
                                                                 @NonNull
                                                                 java.lang.String lastSegment)

doSaveDocument

protected void doSaveDocument(org.eclipse.core.runtime.IProgressMonitor monitor,
                              java.lang.Object element,
                              org.eclipse.jface.text.IDocument document,
                              boolean overwrite)
                       throws org.eclipse.core.runtime.CoreException

Overrides:

doSaveDocument in class org.eclipse.xtext.ui.editor.model.XtextDocumentProvider

Throws:

org.eclipse.core.runtime.CoreException

getCScontentType

protected abstract java.lang.String getCScontentType()

getFileExtension

@NonNull
protected abstract java.lang.String getFileExtension()

handleElementContentChanged

protected void handleElementContentChanged(org.eclipse.ui.IFileEditorInput fileEditorInput)

Overrides:

handleElementContentChanged in class org.eclipse.ui.editors.text.FileDocumentProvider

isDeleted

public boolean isDeleted(java.lang.Object element)

Specified by:

isDeleted in interface org.eclipse.ui.texteditor.IDocumentProvider

Overrides:

isDeleted in class org.eclipse.xtext.ui.editor.model.XtextDocumentProvider

isText

protected boolean isText(java.lang.String loadedAs)

isXML

@Deprecated
protected boolean isXML(@NonNull
                                     java.io.InputStream inputStream)
                              throws java.io.IOException

Deprecated. No longer used.

Throws:

java.io.IOException

isXML

protected boolean isXML(@NonNull
                        java.io.InputStream inputStream,
                        java.lang.String encoding)
                 throws java.io.IOException

Throws:

java.io.IOException

loadResource

protected void loadResource(org.eclipse.xtext.resource.XtextResource resource,
                            java.lang.String document,
                            java.lang.String encoding)
                     throws org.eclipse.core.runtime.CoreException

Overrides:

loadResource in class BaseDocumentProvider

Throws:

org.eclipse.core.runtime.CoreException

setDocumentContent

protected boolean setDocumentContent(org.eclipse.jface.text.IDocument document,
                                     org.eclipse.ui.IEditorInput editorInput,
                                     java.lang.String encoding)
                              throws org.eclipse.core.runtime.CoreException

Overrides:

setDocumentContent in class BaseDocumentProvider

Throws:

org.eclipse.core.runtime.CoreException

setDocumentContent

protected void setDocumentContent(org.eclipse.jface.text.IDocument document,
                                  java.io.InputStream inputStream,
                                  java.lang.String encoding)
                           throws org.eclipse.core.runtime.CoreException

Overrides:

setDocumentContent in class org.eclipse.ui.editors.text.StorageDocumentProvider

Throws:

org.eclipse.core.runtime.CoreException

setDocumentResource

protected void setDocumentResource(org.eclipse.xtext.ui.editor.model.XtextDocument xtextDocument,
                                   org.eclipse.ui.IEditorInput editorInput,
                                   java.lang.String encoding)
                            throws org.eclipse.core.runtime.CoreException

Overrides:

setDocumentResource in class org.eclipse.xtext.ui.editor.model.XtextDocumentProvider

Throws:

org.eclipse.core.runtime.CoreException

setExportDelegateURI

public void setExportDelegateURI(java.lang.Object element,
                                 java.lang.String uri)

setPersistAs

public void setPersistAs(java.lang.Object element,
                         java.lang.String persistAs)

superDoSaveDocument

protected void superDoSaveDocument(org.eclipse.core.runtime.IProgressMonitor monitor,
                                   java.lang.Object element,
                                   org.eclipse.jface.text.IDocument document,
                                   boolean overwrite)
                            throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

superSetDocumentText

@Deprecated
protected void superSetDocumentText(@NonNull
                                                 org.eclipse.xtext.ui.editor.model.XtextDocument document,
                                                 @NonNull
                                                 java.lang.String displayText)
                                          throws org.eclipse.core.runtime.CoreException

Deprecated. no longer used - does nothing - retained for API compatibility

Throws:

org.eclipse.core.runtime.CoreException

superSetDocumentContent

protected void superSetDocumentContent(org.eclipse.jface.text.IDocument document,
                                       java.io.InputStream inputStream,
                                       java.lang.String encoding)
                                throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException