org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/IAsynchronousContentAdapter.java

/*******************************************************************************
 * 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;

/**
 * Provides content for elements in an asynchronous viewer. Note that implementations
 * must provide content asynchronously. 
 * <p>
 * Clients may implement this interface.
 * </p>
 * @since 3.2
 */
public interface IAsynchronousContentAdapter {

    /**
     * Asynchronously retrieves the children of the given parent reporting to the
     * given monitor. If unable to retrieve children, an exception should be reported
     * to the monitor with an appropriate status.
     * 
     * @param parent the element to retrieve children for
     * @param context the context in which children have been requested
     * @param monitor request monitor to report children to
     */
    public void retrieveChildren(Object parent, IPresentationContext context, IChildrenRequestMonitor result);
    
    /**
     * Asynchronously determines whether the given element contains children in the specified
     * context reporting the result to the given monitor. If unable to determine
     * whether the element has children, an exception should be reported to the monitor
     * with an appropriate status.
     * 
     * @param element the element on which children may exist 
     * @param context the context in which children may exist
     * @param monitor request monitor to report the result to
     */
    public void isContainer(Object element, IPresentationContext context, IContainerRequestMonitor result);

}