Class DiffContainer

java.lang.Object
org.eclipse.compare.structuremergeviewer.DiffElement
org.eclipse.compare.structuremergeviewer.DiffContainer
All Implemented Interfaces:
ITypedElement, IDiffContainer, IDiffElement
Direct Known Subclasses:
DiffNode

public abstract class DiffContainer extends DiffElement implements IDiffContainer
The standard implementation of a diff container element.

This class may be instantiated, or further subclassed.

  • Constructor Details

    • DiffContainer

      public DiffContainer(IDiffContainer parent, int kind)
      Creates a new container with the specified kind under the given parent.
      Parameters:
      parent - under which the new container is added as a child or null.
      kind - of difference (defined in Differencer).
  • Method Details

    • findChild

      public IDiffElement findChild(String name)
      Tries to find the child with the given name. Returns null if no such child exists.
      Parameters:
      name - of the child to find
      Returns:
      the first element with a matching name
    • add

      public void add(IDiffElement diff)
      Description copied from interface: IDiffContainer
      Adds the given child to this container. If the child is already contained in this container, this method has no effect.
      Specified by:
      add in interface IDiffContainer
      Parameters:
      diff - the child to be added to this container
    • removeToRoot

      public void removeToRoot(IDiffElement child)
      Description copied from interface: IDiffContainer
      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.
      Specified by:
      removeToRoot in interface IDiffContainer
      Parameters:
      child - the child to be removed from this container
    • remove

      public void remove(IDiffElement child)
      Removes the given child (non-recursively) from this container.
      Parameters:
      child - to remove
    • hasChildren

      public boolean hasChildren()
      Description copied from interface: IDiffContainer
      Returns whether this container has at least one child. In some cases this methods avoids having to call the potential more costly getChildren method.
      Specified by:
      hasChildren in interface IDiffContainer
      Returns:
      true if this container has at least one child
    • getChildren

      public IDiffElement[] getChildren()
      Description copied from interface: IDiffContainer
      Returns the children of this container. If this container has no children an empty array is returned (not null).
      Specified by:
      getChildren in interface IDiffContainer
      Returns:
      the children of this container as an array