ro.sync.exml.workspace.api.standalone

Interface DiffAndMergeTools

All Known Subinterfaces:

StandalonePluginWorkspace, WebappPluginWorkspace

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface DiffAndMergeTools

Tools used for executing operations like finding differences between files and folders, or merging different files.

Since:

18.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	openDiffFilesApplication(java.net.URL leftURL, java.net.URL rightURL) Open the diff files tool with initial left and right URLs to compare.
java.lang.Object	openDiffFilesApplication(java.net.URL leftURL, java.net.URL rightURL, java.net.URL ancestorURL) Open the diff files tool with initial left and right URLs to compare.
java.util.List<MergedFileState>	openMergeApplication(java.io.File baseDir, java.io.File personalModifiedFilesDir, java.io.File externalModifiedFilesDir, java.util.Map<java.lang.String,java.lang.String> mergeOptions) Displays a modal dialog that allows you to see and accept/reject the differences between the provided files.

Method Detail

openDiffFilesApplication

java.lang.Object openDiffFilesApplication(java.net.URL leftURL,
                                          java.net.URL rightURL)

Open the diff files tool with initial left and right URLs to compare. The comparison will begin automatically and the content types for the URLs will be auto-detected. This works only when the API is used in the standalone version of Oxygen.

Parameters:

leftURL - The left-side URL to diff. Can be null.

rightURL - The right-side URL to diff. Can be null.

Returns:

The shown non-modal swing JFrame. You can use that to add a close listener for example.

Since:

18

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

openDiffFilesApplication

java.lang.Object openDiffFilesApplication(java.net.URL leftURL,
                                          java.net.URL rightURL,
                                          java.net.URL ancestorURL)

Open the diff files tool with initial left and right URLs to compare. If the ancestor URL is specified the comparison will be performed in three-way mode. The left and right URLs will be compared relatively to the ancestor (base) URL. If the ancestor URL is null the comparison will be performed in two-way mode. The comparison will begin automatically and the content types for the URLs will be auto-detected. This works only when the API is used in the standalone version of Oxygen.

Parameters:

leftURL - The left-side URL to diff. Can be null.

rightURL - The right-side URL to diff. Can be null.

ancestorURL - The ancestor (base) URL to diff. Can be null.

Returns:

The shown non-modal swing JFrame. You can use that to add a close listener for example.

Since:

18.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

openMergeApplication

java.util.List<MergedFileState> openMergeApplication(java.io.File baseDir,
                                                     java.io.File personalModifiedFilesDir,
                                                     java.io.File externalModifiedFilesDir,
                                                     java.util.Map<java.lang.String,java.lang.String> mergeOptions)
                                              throws MergeFilesException

Displays a modal dialog that allows you to see and accept/reject the differences between the provided files. These differences are obtained as a result of a three-way comparison between:

1. the base files - the ones located in the baseDir directory. These are the initial files, before any changes were made by your or by others.
2. the personal modified files - the ones located in the personalModifiedFilesDir directory. These are actually the base files after they were modified by you. These files will be opened in the left side of the comparison tool.
   OBS: The files are modified during the merging.
3. the external modified files - the ones located in the externalModifiedFilesDir directory. These are actually the base files after they were modified by others. These files will be opened in the right side of the comparison tool.
   These files are not touched by the merging.

For example, let's say that both baseDir and personalModifiedFilesDir contain a file named flowers.dita, but the file is missing from the externalModifiedFilesDir folder. This means that the dialog will present a delete file modification. If you accepted this modification, the flowers.dita file from the personalModifiedFilesDir directory will be removed. When closing the dialog by pressing "OK", this method will return a list containing a single MergedFileState object, with MergedFileState.MergeStatus.DELETED state, pointing to the flowers.dita file from personalModifiedFilesDir.

Parameters:

baseDir - The directory containing initial, unaltered files.

personalModifiedFilesDir - The directory containing the files modified by you. These files are modified during the merging.

externalModifiedFilesDir - The directory containing the files modified by others.

mergeOptions - The options used in the merge operation. The keys that can be used in this map are found in MergeFilesOptionsConstants.

Returns:

The list of merged files states. Each entry from this list corresponds to a merged file and contains information about the file location and the merging result (deleted, added, modified). The list is null when the dialog is canceled.

Throws:

MergeFilesException - Exception thrown in case the merge operation fails.

Since:

18.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.