Interface IStructureCreator2
- All Superinterfaces:
IStructureCreator
- All Known Implementing Classes:
StructureCreator
IStructureCreator
interface that supports the
use of shared documents.
This interface is not intended to be implemented by clients. Client should instead
subclass StructureCreator
.
- Since:
- 3.3
-
Method Summary
Modifier and TypeMethodDescriptioncreateElement
(Object element, Object input, IProgressMonitor monitor) Creates the single node specified by path from the given input object.createStructure
(Object input, IProgressMonitor monitor) Creates a tree structure consisting ofIStructureComparator
s from the given object and returns its root object.void
Release any resources associated with the given object.Methods inherited from interface org.eclipse.compare.structuremergeviewer.IStructureCreator
getContents, getName, getStructure, locate, save
-
Method Details
-
createStructure
Creates a tree structure consisting ofIStructureComparator
s from the given object and returns its root object. Implementing this method typically involves parsing the input object. In case of an error (e.g. a parsing error) the valuenull
is returned.This method is equivalent to
IStructureCreator.getStructure(Object)
with the exception that thedestroy(Object)
method must be called with the returned comparator as a parameter when the comparator is no longer needed. This is done to allow structure creators to make use of shared resources such a file buffer.Also, the node returned from this method should adapt to an
ISharedDocumentAdapter
if the provided input has a shared document adapter and it is being used by the this creator. The convenience classSharedDocumentAdapterWrapper
is provided to allow the creator to wrap the adapter of the input so that the proper key can be returned.- Parameters:
input
- the object from which to create the tree ofIStructureComparator
monitor
- a progress monitor ornull
if progress and cancelation is not required- Returns:
- the root node of the structure or
null
in case of error - Throws:
CoreException
- if structure creation failed; depends on actual implementation- See Also:
-
createElement
ITypedElement createElement(Object element, Object input, IProgressMonitor monitor) throws CoreException Creates the single node specified by path from the given input object. This method is equivalent toIStructureCreator.locate(Object, Object)
with the exception that thedestroy(Object)
method must be called with the returned element as a parameter when the element is no longer needed. This is done to allow structure creators to make use of shared resources such a file buffer.- Parameters:
element
- specifies a sub object within the input objectinput
- the object from which to create theITypedElement
monitor
- a progress monitor ornull
if progress is not desired- Returns:
- the single node specified by
path
ornull
- Throws:
CoreException
- if an error occurs while parsing the input- See Also:
-
destroy
Release any resources associated with the given object. This method must be called for objects returned from eithercreateStructure(Object, IProgressMonitor)
orcreateElement(Object, Object, IProgressMonitor)
.- Parameters:
object
- the object to be destroyed- See Also:
-