com.starbase.starteam.viewcomparemerge
Class FileMergeAdapter

java.lang.Object
  |
  +--com.starbase.starteam.viewcomparemerge.FileMergeAdapter

Direct Known Subclasses:

Custom3WayMergeAdapter, StarTeamFileMergeAdapter, VisMergeAdapter, WorkstationDefaultMergeAdapter

public abstract class FileMergeAdapter

extends java.lang.Object

An abstract class designed to facilitate the use of an external tool for resolving a file merge condition.

See Also:

WorkstationDefaultMergeAdapter, StarTeamFileMergeAdapter, VisMergeAdapter, Custom3WayMergeAdapter

Field Summary

static java.lang.String	PARAM_COMMON_ANCESTOR
static java.lang.String	PARAM_OUTPUT_FILE
static java.lang.String	PARAM_SOURCE_ANCESTOR
static java.lang.String	PARAM_SOURCE_FILE
static java.lang.String	PARAM_TARGET_ANCESTOR
static java.lang.String	PARAM_TARGET_FILE

Constructor Summary

FileMergeAdapter(ItemDifference diff)
Constructs an adapter for resolving a given file merge condition.

Method Summary

int	merge() Runs the external merge tool with parameters that are appropriate for resolving the merge condition of this adapter's ItemDifference.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_SOURCE_FILE

public static final java.lang.String PARAM_SOURCE_FILE

See Also:

Constant Field Values

PARAM_TARGET_FILE

public static final java.lang.String PARAM_TARGET_FILE

See Also:

Constant Field Values

PARAM_SOURCE_ANCESTOR

public static final java.lang.String PARAM_SOURCE_ANCESTOR

See Also:

Constant Field Values

PARAM_TARGET_ANCESTOR

public static final java.lang.String PARAM_TARGET_ANCESTOR

See Also:

Constant Field Values

PARAM_COMMON_ANCESTOR

public static final java.lang.String PARAM_COMMON_ANCESTOR

See Also:

Constant Field Values

PARAM_OUTPUT_FILE

public static final java.lang.String PARAM_OUTPUT_FILE

See Also:

Constant Field Values

Constructor Detail

FileMergeAdapter

public FileMergeAdapter(ItemDifference diff)

Constructs an adapter for resolving a given file merge condition.

Parameters:

diff - The ItemDifference whose file merge condition is to be resolved.

Method Detail

merge

public int merge()
          throws java.io.IOException

Runs the external merge tool with parameters that are appropriate for resolving the merge condition of this adapter's ItemDifference.

If the merge is successful, then the adapter applies the output merged file content to the ItemDifference, and marks the merge condition as resolved.

Any temporary files created during the process are automatically removed.

Returns:

The tool's exit code. Zero on success.

Throws:

IOException - If an error occurs during the invocation of the tool.