org.eclipse.compare
Interface IEditableContent
-
All Known Implementing Classes:
-
DocumentRangeNode,
ResourceNode,
StructureRootNode
-
public interface IEditableContent
Common interface for objects with editable contents.
Typically it is implemented by objects that also implement
the IStreamContentAccessor interface.
Clients may implement this interface.
Note that implementing IEditableContent does not
automatically mean that it is editable. An object is only editable if
it implements IEditableContent and the isEditable method returns true.
-
See Also:
-
IStreamContentAccessor
|
Method Summary
|
boolean
|
isEditable
()
Returns true if this object can be modified. |
ITypedElement
|
replace
(
ITypedElement dest,
ITypedElement src)
This method is called on a parent to add or remove a child,
or to copy the contents of a child. |
void
|
setContent
(byte[] newContent)
Replaces the current content with the given new bytes. |
isEditable
boolean isEditable()
- Returns
true if this object can be modified.
If it returns false the other methods of this API must not be called.
-
-
Returns:
-
true if this object can be modified
setContent
void setContent(byte[] newContent)
- Replaces the current content with the given new bytes.
-
-
Parameters:
-
newContent - this new contents replaces the old contents
replace
ITypedElement replace(
ITypedElement dest,
ITypedElement src)
- This method is called on a parent to add or remove a child,
or to copy the contents of a child.
What to do is encoded in the two arguments as follows:
| add: |
dest == null |
src != null |
| remove: |
dest != null |
src == null |
| copy: |
dest != null |
src != null |
-
-
Parameters:
-
dest - the existing child of this object to be replaced; if null a new child can be added. -
src - the new child to be added or replaced; if null an existing child can be removed.
-
Returns:
- the argument
dest
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
