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
ConstructorsConstructorDescriptionTextFileBufferSnapshot(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 BooleanpredictEquality(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 benulland must be connected at least during the execution of this constructorbufferManager- must not benull
-
-
Method Details
-
getContents
Description copied from interface:ISnapshotA 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
nullif the snapshot has expired
-
predictEquality
Description copied from class:SnapshotPredicts whether this snapshot isequalto the given snapshot without actually obtaining snapshotcontents. Must returnnullif cannot tell for sure. Any non-null result must meet the contract ofISnapshot.isEqualTo(ISnapshot).- Overrides:
predictEqualityin classSnapshot- Parameters:
other- the other snapshot (notnulland not identical to the receiver)- Returns:
trueif the snapshots are predicted to be equal,falseif the snapshots are predicted to be unequal, andnullif there is no prediction
-