public class FileAnnotation extends java.lang.Object implements IFileAnnotation
Constructor and Description |
---|
FileAnnotation(int upper,
int lower,
java.lang.String depotPath,
java.lang.String line,
IClientSummary.ClientLineEnd lineEnd)
Default all-field constructor.
|
FileAnnotation(int order,
java.lang.String depotPath,
int upper,
int lower)
Create a new non-data file annotation with the passed-in parameters.
|
FileAnnotation(java.util.Map<java.lang.String,java.lang.Object> map,
java.lang.String depotPath,
IClientSummary.ClientLineEnd lineEnd)
Construct a suitable FileAnnotation object from the passed-in
map; this map must be in the format and use the fields returned from
a Perforce server annotate command.
|
Modifier and Type | Method and Description |
---|---|
void |
addIntegrationAnnotation(IFileAnnotation annotation)
Add an integration annotation to the contributingSources list.
|
java.util.List<IFileAnnotation> |
getAllIntegrations()
Get a list of all contributing integration annotations for this annotation,
if such a list exists.
|
java.lang.String |
getDepotPath() |
java.lang.String |
getLine() |
java.lang.String |
getLine(boolean processLineEndings) |
IClientSummary.ClientLineEnd |
getLineEnd() |
int |
getLower() |
int |
getOrdering() |
int |
getUpper() |
void |
setDepotPath(java.lang.String depotPath) |
void |
setLine(java.lang.String line) |
void |
setLineEnd(IClientSummary.ClientLineEnd lineEnd) |
void |
setLower(int lower) |
FileAnnotation |
setOrdering(int ordering) |
void |
setUpper(int upper) |
public FileAnnotation(int upper, int lower, java.lang.String depotPath, java.lang.String line, IClientSummary.ClientLineEnd lineEnd)
upper
- upperlower
- lowerdepotPath
- depotPathline
- linelineEnd
- lineEndpublic FileAnnotation(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String depotPath, IClientSummary.ClientLineEnd lineEnd)
Leave lineEnd null for normal use.
map
- mapdepotPath
- depotPathlineEnd
- lineEndpublic FileAnnotation(int order, java.lang.String depotPath, int upper, int lower)
order
- orderdepotPath
- depotPathupper
- upperlower
- lowerpublic void addIntegrationAnnotation(IFileAnnotation annotation)
annotation
- annotationpublic java.lang.String getDepotPath()
getDepotPath
in interface IFileAnnotation
IFileAnnotation.getDepotPath()
public java.lang.String getLine()
getLine
in interface IFileAnnotation
The returned line will never be null, but may be empty.
IFileAnnotation.getLine()
public java.lang.String getLine(boolean processLineEndings)
getLine
in interface IFileAnnotation
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.The returned line will never be null, but may be empty.
IFileAnnotation.getLine(boolean)
public java.util.List<IFileAnnotation> getAllIntegrations()
IFileAnnotation
getAllIntegrations
in interface IFileAnnotation
IFileAnnotation.getAllIntegrations()
public int getLower()
getLower
in interface IFileAnnotation
IFileAnnotation.getLower()
public int getUpper()
getUpper
in interface IFileAnnotation
IFileAnnotation.getUpper()
public void setUpper(int upper)
public void setLower(int lower)
public void setDepotPath(java.lang.String depotPath)
public void setLine(java.lang.String line)
public IClientSummary.ClientLineEnd getLineEnd()
public void setLineEnd(IClientSummary.ClientLineEnd lineEnd)
public int getOrdering()
getOrdering
in interface IFileAnnotation
public FileAnnotation setOrdering(int ordering)