/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.compare;
/**
* 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 IStreamContentAccessor
*/
public interface IEditableContent {
/**
* Returns true
if this object can be modified.
* If it returns false
the other methods of this API must not be called.
*
* @return true
if this object can be modified
*/
boolean isEditable();
/**
* Replaces the current content with the given new bytes.
*
* @param newContent this new contents replaces the old contents
*/
void setContent(byte[] newContent);
/**
* 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 | *
null
a new child can be added.
* @param src the new child to be added or replaced; if null
an existing child can be removed.
* @return the argument dest
*/
ITypedElement replace(ITypedElement dest, ITypedElement src);
}