Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/ICompareInput.java')
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/ICompareInput.java72
1 files changed, 34 insertions, 38 deletions
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/ICompareInput.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/ICompareInput.java
index 49ed4f4ee..ca012ad92 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/ICompareInput.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/ICompareInput.java
@@ -19,34 +19,32 @@ import org.eclipse.swt.graphics.Image;
* and a name and image which is used when displaying the three way input
* in the UI, for example, in a title bar.
* <p>
- * Note: at most two sides of an <code>ICompareInput</code> can be <code>null</code>,
+ * Note: at most two sides of an {@code ICompareInput} can be {@code null},
* (as it is normal for additions or deletions) but not all three.
* <p>
- * <code>ICompareInput</code> provides methods for registering
- * <code>ICompareInputChangeListener</code>s
+ * {@code ICompareInput} provides methods for registering
+ * {@link ICompareInputChangeListener}s
* that get informed if one (or more)
- * of the three sides of an <code>ICompareInput</code> object changes its value.
+ * of the three sides of an {@code ICompareInput} object changes its value.
* <p>
* For example when accepting an incoming addition
- * the (non-<code>null</code>) left side of an <code>ICompareInput</code>
- * is copied to the right side by means of method <code>copy</code>.
- * This should trigger a call to <code>compareInputChanged</code> of registered
- * <code>ICompareInputChangeListener</code>s.
+ * the (non-{@code null}) left side of an {@code ICompareInput}
+ * is copied to the right side by means of method {@code copy}.
+ * This should trigger a call to {@link ICompareInputChangeListener#compareInputChanged} of registered
+ * {@link ICompareInputChangeListener}s.
* <p>
* Clients can implement this interface, or use the convenience implementation
- * <code>DiffNode</code>.
- * </p>
+ * {@link DiffNode}.
*
* @see StructureDiffViewer
* @see org.eclipse.compare.contentmergeviewer.ContentMergeViewer
* @see DiffNode
*/
public interface ICompareInput {
-
/**
* Returns name of input.
* This name is displayed when this input is shown in a viewer.
- * In many cases this name is the name of one of the non-<code>null</code> sides or a combination
+ * In many cases this name is the name of one of the non-{@code null} sides or a combination
* thereof.
*
* @return name of input
@@ -56,46 +54,44 @@ public interface ICompareInput {
/**
* Returns an image representing this input.
* This image is typically displayed when this input is shown in a viewer.
- * In many cases this image is the image of one of the non-<code>null</code> sides.
+ * In many cases this image is the image of one of the non-{@code null} sides.
*
- * @return image representing this input, or <code>null</code> if no icon should be shown
+ * @return image representing this input, or {@code null} if no icon should be shown
*/
Image getImage();
/**
- * Returns the kind of difference between the
- * three sides ancestor, left and right.
- * This field is only meaningful if the <code>ICompareInput</code>
- * is the result of another compare. In this case it is used
- * together with <code>getImage</code> to compose a icon
+ * Returns the kind of difference between the three sides ancestor, left and right.
+ * This field is only meaningful if the {@code ICompareInput} is the result of another
+ * compare. In this case it is used together with {@link #getImage()} to compose an icon
* which reflects the kind of difference between the two or three elements.
*
- * @return kind of difference (see <code>Differencer</code>)
+ * @return kind of difference (see {@link Differencer})
*/
int getKind();
/**
* Returns the ancestor side of this input.
- * Returns <code>null</code> if this input has no ancestor
+ * Returns {@code null} if this input has no ancestor
* or in the two-way compare case.
*
- * @return the ancestor of this input, or <code>null</code>
+ * @return the ancestor of this input, or {@code null}
*/
ITypedElement getAncestor();
/**
* Returns the left side of this input.
- * Returns <code>null</code> if there is no left side (deletion or addition).
+ * Returns {@code null} if there is no left side (deletion or addition).
*
- * @return the left side of this input, or <code>null</code>
+ * @return the left side of this input, or {@code null}
*/
ITypedElement getLeft();
/**
* Returns the right side of this input.
- * Returns <code>null</code> if there is no right side (deletion or addition).
+ * Returns {@code null} if there is no right side (deletion or addition).
*
- * @return the right side of this input, or <code>null</code>
+ * @return the right side of this input, or {@code null}
*/
ITypedElement getRight();
@@ -117,25 +113,25 @@ public interface ICompareInput {
/**
* Copy one side (source) to the other side (destination) depending on the
- * value of <code>leftToRight</code>. This method is called from
+ * value of {@code leftToRight}. This method is called from
* a merge viewer if a corresponding action ("take left" or "take right")
* has been pressed.
* <p>
* The implementation should handle the following cases:
- * <UL>
- * <LI>
- * if the source side is <code>null</code> the destination must be deleted,
- * <LI>
- * if the destination is <code>null</code> the destination must be created
+ * <ul>
+ * <li>
+ * if the source side is {@code null} the destination must be deleted,
+ * <li>
+ * if the destination is {@code null} the destination must be created
* and filled with the contents from the source,
- * <LI>
- * if both sides are non-<code>null</code> the contents of source must be copied to destination.
- * </UL>
+ * <li>
+ * if both sides are non-{@code null} the contents of source must be copied to destination.
+ * </ul>
* In addition the implementation should send out notification to the registered
- * <code>ICompareInputChangeListener</code>.
+ * {@link ICompareInputChangeListener}.
*
- * @param leftToRight if <code>true</code> the left side is copied to the right side.
- * If <code>false</code> the right side is copied to the left side
+ * @param leftToRight if {@code true} the left side is copied to the right side.
+ * If {@code false} the right side is copied to the left side
*/
void copy(boolean leftToRight);
}

Back to the top