01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.openide.nodes;
42:
43: import java.io.IOException;
44:
45: /** Exception indicating that a node could not be found while
46: * traversing a path from the root.
47: *
48: * @author Jaroslav Tulach
49: */
50: public final class NodeNotFoundException extends IOException {
51: static final long serialVersionUID = 1493446763320691906L;
52:
53: /** closest node */
54: private Node node;
55:
56: /** name of child not found */
57: private String name;
58:
59: /** depth of not founded node. */
60: private int depth;
61:
62: /** Constructor.
63: * @param node closest found node to the one being looked for
64: * @param name name of child not found in that node
65: * @param depth depth of the node that was found
66: */
67: NodeNotFoundException(Node node, String name, int depth) {
68: this .node = node;
69: this .name = name;
70: }
71:
72: /** Get the closest node to the target that was able to be found.
73: * @return the closest node
74: */
75: public Node getClosestNode() {
76: return node;
77: }
78:
79: /** Get the name of the missing child of the closest node.
80: * @return the name of the missing child
81: */
82: public String getMissingChildName() {
83: return name;
84: }
85:
86: /** Getter for the depth of the closest node found.
87: * @return the depth (0 for the start node, 1 for its child, etc.)
88: */
89: public int getClosestNodeDepth() {
90: return depth;
91: }
92: }
|