Package org.eclipse.handly.snapshot
Class TextFileBufferSnapshot
java.lang.Object
org.eclipse.handly.snapshot.Snapshot
org.eclipse.handly.snapshot.TextFileBufferSnapshot
- All Implemented Interfaces:
ISnapshot
A snapshot of an
ITextFileBuffer
. Thread-safe.-
Constructor Summary
ConstructorDescriptionTextFileBufferSnapshot
(org.eclipse.core.filebuffers.ITextFileBuffer buffer, org.eclipse.core.filebuffers.ITextFileBufferManager bufferManager) Constructs a new snapshot of the given text file buffer. -
Method Summary
Modifier and TypeMethodDescriptionA snapshot returns the same contents until it expires.protected Boolean
predictEquality
(Snapshot other)
-
Constructor Details
-
TextFileBufferSnapshot
public TextFileBufferSnapshot(org.eclipse.core.filebuffers.ITextFileBuffer buffer, org.eclipse.core.filebuffers.ITextFileBufferManager bufferManager) Constructs a new snapshot of the given text file buffer.- Parameters:
buffer
- a buffer connected through the given buffer manager - must not benull
and must be connected at least during the execution of this constructorbufferManager
- must not benull
-
-
Method Details
-
getContents
Description copied from interface:ISnapshot
A snapshot returns the same contents until it expires. This is the contents of the underlying resource or buffer at the moment the snapshot was taken. Expired snapshots returnnull
.Protractedly holding on to the returned contents is not recommended, as it may potentially consume significant amount of space.
- Returns:
- the contents of the snapshot, or
null
if the snapshot has expired
-
predictEquality
Description copied from class:Snapshot
Predicts whether this snapshot isequal
to the given snapshot without actually obtaining snapshotcontents
. Must returnnull
if cannot tell for sure. Any non-null result must meet the contract ofISnapshot.isEqualTo(ISnapshot)
.- Overrides:
predictEquality
in classSnapshot
- Parameters:
other
- the other snapshot (notnull
and not identical to the receiver)- Returns:
true
if the snapshots are predicted to be equal,false
if the snapshots are predicted to be unequal, andnull
if there is no prediction
-