public interface ICoreTextFileBufferProvider
ITextFileBuffer
for an underlying file.
Essentially, combines an ITextFileBufferManager
and a file location.Modifier and Type | Method and Description |
---|---|
void |
connect(org.eclipse.core.runtime.IProgressMonitor monitor)
Connects the underlying file buffer to this provider.
|
void |
disconnect(org.eclipse.core.runtime.IProgressMonitor monitor)
Disconnects the underlying file buffer from this provider.
|
static ICoreTextFileBufferProvider |
forFileStore(org.eclipse.core.filesystem.IFileStore fileStore,
org.eclipse.core.filebuffers.ITextFileBufferManager bufferManager)
Returns an
ICoreTextFileBufferProvider for the given
file store and buffer manager. |
static ICoreTextFileBufferProvider |
forLocation(org.eclipse.core.runtime.IPath location,
org.eclipse.core.filebuffers.LocationKind locationKind,
org.eclipse.core.filebuffers.ITextFileBufferManager bufferManager)
Returns an
ICoreTextFileBufferProvider for the given
file location and buffer manager. |
org.eclipse.core.filebuffers.ITextFileBuffer |
getBuffer()
Returns the
ITextFileBuffer managed for the underlying file,
or null if there is no such buffer. |
org.eclipse.core.filebuffers.ITextFileBufferManager |
getBufferManager()
Returns the underlying
ITextFileBufferManager . |
void connect(org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
getBuffer()
returns the same buffer instance until
disconnect
is called.monitor
- a progress monitor, or null
if progress reporting is not desired. The caller must not rely on
IProgressMonitor.done()
having been called by the receiverorg.eclipse.core.runtime.CoreException
- if the file buffer could not be connectedorg.eclipse.core.runtime.OperationCanceledException
- if this method is canceledvoid disconnect(org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
getBuffer()
will return a valid buffer.monitor
- a progress monitor, or null
if progress reporting is not desired. The caller must not rely on
IProgressMonitor.done()
having been called by the receiverorg.eclipse.core.runtime.CoreException
- if the file buffer could not be disconnectedorg.eclipse.core.runtime.OperationCanceledException
- if this method is canceledorg.eclipse.core.filebuffers.ITextFileBuffer getBuffer()
ITextFileBuffer
managed for the underlying file,
or null
if there is no such buffer.null
if noneorg.eclipse.core.filebuffers.ITextFileBufferManager getBufferManager()
ITextFileBufferManager
.null
)static ICoreTextFileBufferProvider forLocation(org.eclipse.core.runtime.IPath location, org.eclipse.core.filebuffers.LocationKind locationKind, org.eclipse.core.filebuffers.ITextFileBufferManager bufferManager)
ICoreTextFileBufferProvider
for the given
file location and buffer manager.location
- not null
locationKind
- not null
bufferManager
- not null
null
)static ICoreTextFileBufferProvider forFileStore(org.eclipse.core.filesystem.IFileStore fileStore, org.eclipse.core.filebuffers.ITextFileBufferManager bufferManager)
ICoreTextFileBufferProvider
for the given
file store and buffer manager.fileStore
- not null
bufferManager
- not null
null
)Copyright (c) 2014, 2018 1C-Soft LLC and others. Made available under the Eclipse Public License 2.0