|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFileAnnotation
Describes a Perforce file annotation as returned from the annotation command. See the main Perforce documentation for the annotate command for detailed descriptions of Perforce file version annotation.
Method Summary | |
---|---|
List<IFileAnnotation> |
getAllIntegrations()
Get a list of all contributing integration annotations for this annotation, if such a list exists. |
String |
getDepotPath()
Get the associated depot path for this annotation, if one is available. |
String |
getLine()
Get the line being annotated. |
String |
getLine(boolean processLineEndings)
Get the line being annotated, with optional line ending processing based on client settings (if available). |
int |
getLower()
Get the lower version or change number for the associated annotation. |
int |
getOrdering()
Get the ordering of this annotation in the associated allIntegrations list, if it exists. |
int |
getUpper()
Get the upper version or change number for the associated annotation. |
Method Detail |
---|
int getLower()
int getUpper()
String getLine()
The returned line will never be null, but may be empty.
String getLine(boolean processLineEndings)
The returned line will never be null, but may be empty.
processLineEndings
- if true, and if a client is associated with this
annotation (i.e. it was created by one of the IServer or IFileSpec
annotation methods, and a client was associated with the server at the
time the IServer or IFileSpec call was made), the returned string will
attempt to honor client line end settings where possible; if there are no
available settings, the local line ending is appended. If processLineEndings
is not true, the results are identical to calling the no-argument getLine method.String getDepotPath()
List<IFileAnnotation> getAllIntegrations()
int getOrdering()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |