1/*
2 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.swing.tree;
27
28import javax.swing.event.TreeExpansionEvent;
29
30/**
31 * Exception used to stop an expand/collapse from happening.
32 * See <a
33 href="http://docs.oracle.com/javase/tutorial/uiswing/events/treewillexpandlistener.html">How to Write a Tree-Will-Expand Listener</a>
34 * in <em>The Java Tutorial</em>
35 * for further information and examples.
36 *
37 * @author Scott Violet
38 */
39@SuppressWarnings("serial") // Same-version serialization only
40public class ExpandVetoException extends Exception {
41    /** The event that the exception was created for. */
42    protected TreeExpansionEvent      event;
43
44    /**
45     * Constructs an ExpandVetoException object with no message.
46     *
47     * @param event  a TreeExpansionEvent object
48     */
49
50    public ExpandVetoException(TreeExpansionEvent event) {
51        this(event, null);
52    }
53
54    /**
55     * Constructs an ExpandVetoException object with the specified message.
56     *
57     * @param event    a TreeExpansionEvent object
58     * @param message  a String containing the message
59     */
60    public ExpandVetoException(TreeExpansionEvent event, String message) {
61        super(message);
62        this.event = event;
63    }
64}
65