| /******************************************************************************* |
| * Copyright (c) 2005, 2006 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.debug.internal.ui.viewers.provisional; |
| |
| |
| /** |
| * Describes a change within a model. A delta is a hierarchical description of changes |
| * within a model. It constists of a tree of nodes. Each node references an element |
| * from a model desribing how that element changed. A model proxy fires model deltas |
| * as its model changes in order to update views displaying that model. |
| * <p> |
| * Each node in a model delta describes the following: |
| * <ul> |
| * <li>the type of change - for example, whether an element was added, removed, |
| * or whether its content or state changed</li> |
| * <li>action to consider - for example, select or reveal the element</li> |
| * </ul> |
| * </p> |
| * <p> |
| * Clients are not intended to implement this interface directly. Instead, clients |
| * creating and firing model deltas should create instances of |
| * {@link org.eclipse.debug.internal.ui.viewers.update.ModelDelta}. |
| * </p> |
| * </p> |
| * @since 3.2 |
| */ |
| public interface IModelDelta { |
| |
| // types of changes |
| |
| /** |
| * Indicates an element has not changed, but has children that have |
| * changed in some way. |
| */ |
| public static int NO_CHANGE = 0; |
| /** |
| * Indicates an element has been added to the model, as described by |
| * its path. |
| */ |
| public static int ADDED = 1; |
| /** |
| * Indicates an element has been removed from the model, as described by |
| * its path. |
| */ |
| public static int REMOVED = 1 << 1; |
| /** |
| * Indicates an element has been replaced in the model, as described by |
| * its path. In this case a replacement element is also specified in the |
| * model delta node. |
| */ |
| public static int REPLACED = 1 << 3; |
| /** |
| * Indicates an element has been inserted into the model, as described |
| * by its path and index. |
| */ |
| public static int INSERTED = 1 << 4; |
| |
| // how an element changed |
| |
| /** |
| * Indicates an elements content has changed (i.e. its children). |
| */ |
| public static int CONTENT = 1 << 10; |
| /** |
| * Indicates an elements state has changed (i.e. label) |
| */ |
| public static int STATE = 1 << 11; |
| |
| // Suggested actions |
| |
| /** |
| * Suggests that the element should be expanded, as described by its path. |
| */ |
| public static int EXPAND = 1 << 20; |
| /** |
| * Suggests that the element should be selected, as described by its path. |
| */ |
| public static int SELECT = 1 << 21; |
| /** |
| * Returns the parent of this node, or <code>null</code> if this is |
| * a root node. |
| * |
| * @return parent node or <code>null</code> if this is a root node |
| */ |
| public IModelDelta getParent(); |
| |
| /** |
| * Returns the model element this node describes. |
| * |
| * @return associated model element |
| */ |
| public Object getElement(); |
| |
| /** |
| * Returns flags describing how this element changed. A bit mask of the |
| * change type constants described in {@link IModelDelta}. |
| * |
| * @return change flags |
| */ |
| public int getFlags(); |
| |
| /** |
| * Returns nodes describing changed children, possibly an empty collection. |
| * |
| * @return changed children, possibly empty |
| */ |
| public ModelDelta[] getNodes(); |
| |
| /** |
| * When a node indicates the <code>IModelDelta.REPLACED</code> flag, this method |
| * returns the replacement element, otherwise <code>null</code>. |
| * |
| * @return replacement element or <code>null</code> |
| */ |
| public Object getReplacementElement(); |
| |
| /** |
| * When a node indicates the <code>IModelDelta.INSERTED</code> flag, this method |
| * returns the index that the new element should be inserted at relative to its |
| * parents children, otherwise -1. |
| * |
| * @return insertion index or -1 |
| */ |
| public int getIndex(); |
| |
| } |