org.eclipse.compare.structuremergeviewer.IDiffContainer Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2011 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.structuremergeviewer;
/**
* 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.
*
* @see Differencer
* @see DiffTreeViewer
*/
public interface IDiffContainer extends IDiffElement {
/**
* Returns whether this container has at least one child.
* In some cases this methods avoids having to call the
* potential more costly getChildren method.
*
* @return true if this container has at least one child
*/
boolean hasChildren();
/**
* Returns the children of this container.
* If this container has no children an empty array is returned (not null).
*
* @return the children of this container as an array
*/
IDiffElement[] getChildren();
/**
* Adds the given child to this container.
* If the child is already contained in this container, this method has no effect.
*
* @param child the child to be added to this container
*/
void add(IDiffElement child);
/**
* Removes the given child from this container.
* If the container becomes empty it is removed from its container.
* If the child is not contained in this container, this method has no effect.
*
* @param child the child to be removed from this container
*/
void removeToRoot(IDiffElement child);
}