Home >> All >> org >> eclipse >> compare >> [ structuremergeviewer Javadoc ]

• org.eclipse.compare.structuremergeviewer: Javadoc index of package org.eclipse.compare.structuremergeviewer.


Package Samples:

• org.eclipse.compare.structuremergeviewer

Classes:

• Differencer: A generic two-way or three-way differencing engine. The engine is used by calling one of the findDifferences methods and passing in the objects to compare. The engine calls the following methods on the input objects to perform the compare: getChildren : for enumerating the children of an object (if any), contentsEqual : for comparing the content of leaf objects, that is, objects without children, visit : for every pair of compared object the compare result is passed in. Clients may use as is, or subclass to provide a custom implementation for the three hooks. However the default implementation ...
• IStructureCreator: Interface used to create a hierarchical structure of IStructureComparator s for a given input object. In addition, it provides methods for locating a path in the hierarchical structure and to map a node of this structure back to the corresponding input object. Structure creators are used in the following contexts: the StructureDiffViewer uses an IStructureCreator to build two (or three) tree structures of its input elements (method getStructure ). These trees are then compared with each other by means of the differencing engine and displayed with the DiffTreeViewer , the ReplaceWithEditionDialog ...
• ICompareInput: Interface for objects used as input to a two-way or three-way compare viewer. It defines API for accessing the three sides for the compare, and a name and image which is used when displaying the three way input in the UI, for example, in a title bar. Note: at most two sides of an ICompareInput can be null , (as it is normal for additions or deletions) but not all three. ICompareInput provides methods for registering ICompareInputChangeListener s that get informed if one (or more) of the three sides of an ICompareInput object changes its value. For example when accepting an incoming addition the ...
• IDiffElement: An IDiffElement is used in the DiffTreeViewer to display the kind of change detected as the result of a two-way or three-way compare. The base interface ITypedElement provides a name, a type, and an image. IDiffElement adds API for maintaining a parent relationship. DiffTreeViewer works on a tree of IDiffElements . Leaf elements must implement the IDiffElement interface, inner nodes the IDiffContainer interface. IDiffElement s are typically created as the result of performing a compare with the Differencer . Clients may implement this interface, or use one of the standard implementations, DiffElement ...
• DocumentRangeNode: A document range node represents a structural element when performing a structure compare of documents. DocumentRangeNodes are created while parsing the document and represent a semantic entity (e.g. a Java class or method). As a consequence of the parsing a DocumentRangeNode maps to a range of characters in the document. Since a DocumentRangeNode implements the IStructureComparator and IStreamContentAccessor interfaces it can be used as input to the differencing engine. This makes it possible to perform a structural diff on a document and have the nodes and leaves of the compare easily map to ...
• ICompareInputChangeListener: Listener that gets informed if one (or more) of the three sides of an ICompareInput object changes its value. For example when accepting an incoming addition the (non-null) left side of an ICompareInput is copied to the right side (which was null ). This triggers a call to compareInputChanged of registered ICompareInputChangeListener . Note however, that listener are not informed if the content of one of the sides changes. Clients may implement this interface. It is also implemented by viewers that take an ICompareInput as input.
• DiffNode: Diff node are used as the compare result of the differencing engine. Since it implements the ITypedElement and ICompareInput interfaces it can be used directly to display the compare result in a DiffTreeViewer and as the input to any other compare/merge viewer. DiffNode s are typically created as the result of performing a compare with the Differencer . Clients typically use this class as is, but may subclass if required.
• IDiffContainer: IDiffContainer is a IDiffElement with children. IDiffContainer are the inner nodes displayed by the DiffTreeViewer . IDiffContainer are typically created as the result of performing a compare with the Differencer . Clients may implement this interface, or use one of the standard implementations, DiffContainer or DiffNode .
• StructureDiffViewer: A diff tree viewer that can be configured with a IStructureCreator to retrieve a hierarchical structure from the input object (an ICompareInput ) and perform a two-way or three-way compare on it. This class may be instantiated; it is not intended to be subclassed outside this package.
• DiffTreeViewer: A tree viewer that works on objects implementing the IDiffContainer and IDiffElement interfaces. This class may be instantiated; it is not intended to be subclassed outside this package.
• IStructureComparator: Interface used to compare hierarchical structures. It is used by the differencing engine. Clients typically implement this interface in an adaptor class which wrappers the objects to be compared.
• DiffElement: An abstract base implementation of the IDiffElement interface. Subclasses may add behavior and state, and may override getImage and getType to suit.
• DiffContainer: The standard implementation of a diff container element. This class may be instantiated, or further subclassed.

Home | Contact Us | Privacy Policy | Terms of Service