|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.clients.versioncontrol.conflicts.ConflictDescription
public abstract class ConflictDescription
This is the base conflict description class. It presents textual descriptions
of conflicts, primarily for UI. This class is abstract, to get a
ConflictDescription
, you should call
ConflictDescription#getConflictDescription(ConflictCategory, Conflict)
.
Constructor Summary | |
---|---|
protected |
ConflictDescription(Workspace workspace,
Conflict conflict,
ItemSpec[] conflictItemSpecs)
Internal constructor for creating a conflict description. |
Method Summary | |
---|---|
boolean |
analyzeConflict()
Analyze the conflict for mergeability, enablement, etc. |
void |
clearAnalysis()
Clears any data leftover from the analysis of this conflict. |
java.lang.String |
getChangeDescription()
Returns the "change description" - number of local/server/conflicting changes. |
Conflict |
getConflict()
Get the underlying core conflict for this conflict. |
abstract ConflictCategory |
getConflictCategory()
Gets the category of this conflict |
ItemSpec[] |
getConflictItemSpecs()
The item specs queried to return this conflict. |
abstract java.lang.String |
getDescription()
A long description of this conflict, suitable for display to the user. |
java.lang.String |
getLocalFileDescription()
Gets the description of the local file. |
java.lang.String |
getLocalPath()
Gets the local filename affected by the conflict. |
java.lang.String |
getLocalPath(ConflictDescriptionPathType pathType)
Gets the local filename affected by the conflict. |
abstract java.lang.String |
getName()
A short description of the conflict, eg "Version Conflict" |
java.lang.String |
getRemoteFileDescription()
Gets the description of the server's file. |
abstract ConflictResolution[] |
getResolutions(ConflictResolutionContributor resolutionContributor)
Gets the resolution options for this particular conflict with the available merge toolset. |
java.lang.String |
getServerPath()
Gets the server filename affected by this conflict. |
Workspace |
getWorkspace()
Get the workspace this conflict is occurring in. |
boolean |
hasAnalyzed()
Returns whether this conflict has been analyzed for mergeability. |
boolean |
isBaseless()
|
boolean |
isResolutionEnabled(ConflictResolution resolution)
Determines if a conflict resolution should be enabled (shown to the user.) We may know ahead of time that certain conflict resolutions (for example, AcceptMerge) are invalid (due to analyzing the conflict.) |
protected java.util.Collection<ConflictResolution> |
loadContributedResolutions(ConflictResolutionContributor resolutionContributor,
ConflictResolutionOptions resolutionOptions)
Utility method for subclasses: loads contributed conflict resolution options from the resolution contributor. |
boolean |
showChangeDescription()
The UI should attempt to show a change description (number of local/server/conflicting changes.) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected ConflictDescription(Workspace workspace, Conflict conflict, ItemSpec[] conflictItemSpecs)
conflict
- the Conflict to wrapMethod Detail |
---|
public Workspace getWorkspace()
public Conflict getConflict()
public ItemSpec[] getConflictItemSpecs()
null
or empty.public abstract ConflictCategory getConflictCategory()
public java.lang.String getLocalPath()
public java.lang.String getLocalPath(ConflictDescriptionPathType pathType)
null
), then the source
local file. This may be overridden with the pathType argument.
pathType
- May be ConflictDescriptionPathType.SOURCE
to prefer the
source local item (if not null
)
null
public java.lang.String getServerPath()
public java.lang.String getLocalFileDescription()
public java.lang.String getRemoteFileDescription()
public boolean isBaseless()
public abstract java.lang.String getName()
public abstract java.lang.String getDescription()
public boolean showChangeDescription()
public java.lang.String getChangeDescription()
public boolean analyzeConflict()
public boolean hasAnalyzed()
public void clearAnalysis()
public abstract ConflictResolution[] getResolutions(ConflictResolutionContributor resolutionContributor)
null
and
contains a matching tool, external resolution options may be available.
resolutionContributor
- an object which contributes resolutions for conflicts. May be
null
, but external resolution options won't be
available.
ConflictResolution
s for this particular
conflict.public boolean isResolutionEnabled(ConflictResolution resolution)
resolution
- The resolution to examine
protected final java.util.Collection<ConflictResolution> loadContributedResolutions(ConflictResolutionContributor resolutionContributor, ConflictResolutionOptions resolutionOptions)
resolutionContributor
- The ConflictResolutionContributor
for this product (may be
null
)resolutionOptions
- The ResolutionOptions
for this conflict description (not
null
)
null
)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |