public abstract class Revision extends Object
ILineRange
s.
Clients may subclass.
Modifier | Constructor and Description |
---|---|
protected |
Revision()
Creates a new revision.
|
Modifier and Type | Method and Description |
---|---|
void |
addRange(ILineRange range)
Adds a line range to this revision.
|
String |
getAuthor()
Returns the display string for the author of this revision.
|
abstract RGB |
getColor()
Returns the author color for this revision.
|
abstract Date |
getDate()
Returns the modification date of this revision.
|
abstract Object |
getHoverInfo()
Returns the hover information that will be shown when the user hovers over the a change
region of this revision.
|
abstract String |
getId()
Returns the unique (within the document) id of this revision.
|
List<RevisionRange> |
getRegions()
Returns the contained
RevisionRange s adapted to the current diff state. |
String |
toString() |
public final void addRange(ILineRange range) throws IndexOutOfBoundsException
range
- a line range that was changed with this revisionIndexOutOfBoundsException
- if the line range is empty or has a negative start linepublic final List<RevisionRange> getRegions()
RevisionRange
s adapted to the current diff state. The returned
information is only valid at the moment it is returned, and may change as the annotated
document is modified.public abstract Object getHoverInfo()
Note: The hover information control which is used to display the information must be able process the given object. If the default information control creator is used the supported format is simple text, full HTML or an HTML fragment.
null
for no hoverRevisionInformation.setHoverControlCreator(IInformationControlCreator)
public abstract RGB getColor()
Revisions from the same author must return the same color and revisions from different authors must return distinct colors.
public abstract String getId()
public abstract Date getDate()
public String getAuthor()
Subclasses should replace - the default implementation returns the empty string.
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.