jdk

1
/*
2
 * Copyright (c) 2016, 2018, 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

26
package java.awt.desktop;
27

28
/**
29
 * An implementor determines if requests to quit this application should proceed
30
 * or cancel.
31
 *
32
 * @see java.awt.Desktop#setQuitHandler(QuitHandler)
33
 * @see java.awt.Desktop#setQuitStrategy(QuitStrategy)
34
 * @since 9
35
 */
36
public interface QuitHandler {
37

38
    /**
39
     * Invoked when the application is asked to quit.
40
     * <p>
41
     * Implementors must call either {@link QuitResponse#cancelQuit()},
42
     * {@link QuitResponse#performQuit()}, or ensure the application terminates.
43
     * The process (or log-out) requesting this app to quit will be blocked
44
     * until the {@link QuitResponse} is handled. Apps that require complex UI
45
     * to shutdown may call the {@link QuitResponse} from any thread. Your app
46
     * may be asked to quit multiple times before you have responded to the
47
     * initial request. This handler is called each time a quit is requested,
48
     * and the same {@link QuitResponse} object is passed until it is handled.
49
     * Once used, the {@link QuitResponse} cannot be used again to change the
50
     * decision.
51
     *
52
     * @param  e the request to quit this application
53
     * @param  response the one-shot response object used to cancel or proceed
54
     *         with the quit action
55
     */
56
    public void handleQuitRequestWith(QuitEvent e, QuitResponse response);
57
}
58