Package org.eclipse.ui.editors.text

Class StorageDocumentProvider

    • Field Detail

      • DEFAULT_FILE_SIZE

        protected static final int DEFAULT_FILE_SIZE
        Default file size.
        Since:
        2.1
        See Also:
        Constant Field Values

    • Constructor Detail

      • StorageDocumentProvider

        public StorageDocumentProvider()
        Creates a new document provider.
        Since:
        2.0

    • Method Detail

      • setDocumentContent

        @Deprecated
protected void setDocumentContent​(IDocument document,
                                  InputStream contentStream)
                           throws CoreException
        Deprecated.
        use encoding based version instead
        Initializes the given document with the given stream.
        Parameters:
        document - the document to be initialized
        contentStream - the stream which delivers the document content
        Throws:
        CoreException - if the given stream can not be read

      • setDocumentContent

        protected void setDocumentContent​(IDocument document,
                                  InputStream contentStream,
                                  String encoding)
                           throws CoreException
        Initializes the given document with the given stream using the given encoding.
        Parameters:
        document - the document to be initialized
        contentStream - the stream which delivers the document content
        encoding - the character encoding for reading the given stream
        Throws:
        CoreException - if the given stream can not be read
        Since:
        2.0

      • setDocumentContent

        @Deprecated
protected boolean setDocumentContent​(IDocument document,
                                     IEditorInput editorInput)
                              throws CoreException
        Deprecated.
        use the encoding based version instead
        Initializes the given document from the given editor input using the default character encoding.
        Parameters:
        document - the document to be initialized
        editorInput - the input from which to derive the content of the document
        Returns:
        true if the document content could be set, false otherwise
        Throws:
        CoreException - if the given editor input cannot be accessed
        Since:
        2.0

      • setDocumentContent

        protected boolean setDocumentContent​(IDocument document,
                                     IEditorInput editorInput,
                                     String encoding)
                              throws CoreException
        Initializes the given document from the given editor input using the given character encoding.
        Parameters:
        document - the document to be initialized
        editorInput - the input from which to derive the content of the document
        encoding - the character encoding used to read the editor input
        Returns:
        true if the document content could be set, false otherwise
        Throws:
        CoreException - if the given editor input cannot be accessed
        Since:
        2.0

      • createEmptyDocument

        protected IDocument createEmptyDocument()
        Factory method for creating empty documents.
        Returns:
        the newly created document
        Since:
        2.1

      • setupDocument

        protected void setupDocument​(Object element,
                             IDocument document)
        Sets up the given document as it would be provided for the given element. The content of the document is not changed. This default implementation is empty. Subclasses may reimplement.
        Parameters:
        element - the blue-print element
        document - the document to set up
        Since:
        3.0

      • createElementInfo

        protected AbstractDocumentProvider.ElementInfo createElementInfo​(Object element)
                                                          throws CoreException
        Description copied from class: AbstractDocumentProvider
        Creates a new element info object for the given element.

        This method is called from connect when an element info needs to be created. The AbstractDocumentProvider implementation of this method returns a new element info object whose document and annotation model are the values of createDocument(element) and createAnnotationModel(element), respectively. Subclasses may override.

        Overrides:
        createElementInfo in class AbstractDocumentProvider
        Parameters:
        element - the element
        Returns:
        a new element info object
        Throws:
        CoreException - if the document or annotation model could not be created

      • doSaveDocument

        protected void doSaveDocument​(IProgressMonitor monitor,
                              Object element,
                              IDocument document,
                              boolean overwrite)
                       throws CoreException
        Description copied from class: AbstractDocumentProvider
        Performs the actual work of saving the given document provided for the given element.

        Subclasses must implement this method.

        Specified by:
        doSaveDocument in class AbstractDocumentProvider
        Parameters:
        monitor - a progress monitor to report progress and request cancelation
        element - the element
        document - the document
        overwrite - indicates whether an overwrite should happen if necessary
        Throws:
        CoreException - if document could not be stored to the given element

      • handleCoreException

        protected void handleCoreException​(CoreException exception,
                                   String message)
        Defines the standard procedure to handle CoreExceptions. Exceptions are written to the plug-in log.
        Parameters:
        exception - the exception to be logged
        message - the message to be logged
        Since:
        2.0

      • updateCache

        protected void updateCache​(IStorageEditorInput input)
                    throws CoreException
        Updates the internal cache for the given input.
        Parameters:
        input - the input whose cache will be updated
        Throws:
        CoreException - if the storage cannot be retrieved from the input
        Since:
        2.0

      • isReadOnly

        public boolean isReadOnly​(Object element)
        Description copied from interface: IDocumentProviderExtension
        Returns whether the document provider thinks that the given element is read-only. If this method returns true, saveDocument could 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:
        isReadOnly in interface IDocumentProviderExtension
        Overrides:
        isReadOnly in class AbstractDocumentProvider
        Parameters:
        element - the element
        Returns:
        true if the given element is read-only, false otherwise

      • isModifiable

        public boolean isModifiable​(Object element)
        Description copied from interface: IDocumentProviderExtension
        Returns whether the document provider thinks that the given element can persistently be modified. This is orthogonal to isReadOnly as 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:
        isModifiable in interface IDocumentProviderExtension
        Overrides:
        isModifiable in class AbstractDocumentProvider
        Parameters:
        element - the element
        Returns:
        true if the given element is modifiable, false otherwise

      • getEncoding

        public String getEncoding​(Object element)
        Description copied from interface: IStorageDocumentProvider
        Returns the character encoding for the given element, or null if the element is not managed by this provider.
        Specified by:
        getEncoding in interface IStorageDocumentProvider
        Parameters:
        element - the element
        Returns:
        the encoding for the given element

      • setEncoding

        public void setEncoding​(Object element,
                        String encoding)
        Description copied from interface: IStorageDocumentProvider
        Sets the encoding for the given element. If encoding is null the workbench's character encoding should be used.
        Specified by:
        setEncoding in interface IStorageDocumentProvider
        Parameters:
        element - the element
        encoding - the encoding to be used

      • getPersistedEncoding

        protected String getPersistedEncoding​(Object element)
        Returns the persisted encoding for the given element.
        Parameters:
        element - the element for which to get the persisted encoding
        Returns:
        the persisted encoding
        Since:
        2.1

      • persistEncoding

        protected void persistEncoding​(Object element,
                               String encoding)
                        throws CoreException
        Persists the given encoding for the given element.
        Parameters:
        element - the element for which to store the persisted encoding
        encoding - the encoding
        Throws:
        CoreException - if the operation fails
        Since:
        2.1