/*******************************************************************************
 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
 * in Industry THTH ry.
 * 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:
 *     VTT Technical Research Centre of Finland - initial API and implementation
 *******************************************************************************/
package org.simantics.browsing.ui.content;

import org.simantics.browsing.ui.BuiltinKeys;
import org.simantics.browsing.ui.NodeContext;


/**
 * A class describing the result of a {@link BuiltinKeys#PRUNED_CHILDREN} query.
 * 
 * @author Tuukka Lehtonen
 */
public final class PrunedChildrenResult {

    public static final PrunedChildrenResult EMPTY = new PrunedChildrenResult(0, NodeContext.NONE);

    private final int                        originalChildCount;
    private final NodeContext[]              prunedChildren;

    public PrunedChildrenResult(int originalChildCount, NodeContext[] prunedChildren) {
        this.originalChildCount = originalChildCount;
        this.prunedChildren = prunedChildren;
    }

    public int getOriginalChildCount() {
        return originalChildCount;
    }

    public NodeContext[] getPrunedChildren() {
        return prunedChildren;
    }

    @Override
    public String toString() {
        return "PrunedChildrenResult [original count=" + originalChildCount + ", pruned children=" + prunedChildren.length + "]";
    }

}