org.electrocodeogram.cpc.merge.api.strategy
Interface IReadableMergeTask

public interface IReadableMergeTask

A special read-only interface which corresponds to the IMergeTask interface.

This interface is meant to underline the fact that a MergeTask must not be modified by an IMergeStrategy. It does thus not extend IMergeTask.

Author:

vw

See Also:

IMergeTask, MergeTask, IMergeProvider, IMergeStrategy

Method Summary

ICloneFile	getBaseCloneFile() Retrieves the base revision of the ICloneFile underlying this merge task.
java.util.List<IClone>	getBaseClones() Retrieves the list of clone data for the base revision of the source file.
java.lang.String	getBaseSourceFileContent() Retrieves the content for the base revision of the source file.
ICloneFile	getLocalCloneFile() Retrieves the local ICloneFile underlying this merge task.
java.util.List<IClone>	getLocalClones() Retrieves the list of clone data for the local revision of the source file.
java.lang.String	getLocalSourceFileContent() Retrieves the content for the local revision of the source file.
java.lang.String	getMergedSourceFileContent() Retrieves the merged content of the source file.
ICloneFile	getRemoteCloneFile() Retrieves the remote ICloneFile underlying this merge task.
java.util.List<IClone>	getRemoteClones() Retrieves the list of clone data for the remote revision of the source file.
java.lang.String	getRemoteSourceFileContent() Retrieves the content for the remote revision of the source file.
boolean	isLocalBaseInSyncHint() Specifies whether the local revision of the source file is guaranteed to be in sync with the base revision.
boolean	isThreeWayMerge() Returns true if all base revision data is available.

Method Detail

getLocalCloneFile

ICloneFile getLocalCloneFile()

Retrieves the local ICloneFile underlying this merge task.

Returns:

the local file, never null.

getLocalClones

java.util.List<IClone> getLocalClones()

Retrieves the list of clone data for the local revision of the source file.

Returns:

list of local clones, never null.

getLocalSourceFileContent

java.lang.String getLocalSourceFileContent()

Retrieves the content for the local revision of the source file.

Returns:

local source file content, never null.

isLocalBaseInSyncHint

boolean isLocalBaseInSyncHint()

Specifies whether the local revision of the source file is guaranteed to be in sync with the base revision.

Returns:

true if local and base revisions are in sync, false otherwise.

getRemoteCloneFile

ICloneFile getRemoteCloneFile()

Retrieves the remote ICloneFile underlying this merge task.

Returns:

remote file, never null.

getRemoteClones

java.util.List<IClone> getRemoteClones()

Retrieves the list of clone data for the remote revision of the source file.

Returns:

list of remote clones, never null.

getRemoteSourceFileContent

java.lang.String getRemoteSourceFileContent()

Retrieves the content for the remote revision of the source file.

Returns:

remote content of source file, never null.

getBaseCloneFile

ICloneFile getBaseCloneFile()

Retrieves the base revision of the ICloneFile underlying this merge task.

Returns:

base revision of file, may be NULL.

getBaseClones

java.util.List<IClone> getBaseClones()

Retrieves the list of clone data for the base revision of the source file.

Returns:

list of base revision clones, may be NULL.

getBaseSourceFileContent

java.lang.String getBaseSourceFileContent()

Retrieves the content for the base revision of the source file.

Returns:

base resivison source file content, may be NULL.

getMergedSourceFileContent

java.lang.String getMergedSourceFileContent()

Retrieves the merged content of the source file.

Returns:

merged file content, never null.

isThreeWayMerge

boolean isThreeWayMerge()

Returns true if all base revision data is available.
Otherwise false is returned. False is also returned if this merge task is not valid.
Convenience method.