jdk/src/java.desktop/macosx/classes/com/apple/eawt/QuitHandler.java
changeset 36959 d839463825a2
parent 36853 9001df2d68e9
parent 36958 8a320111d9fe
child 36960 d7731fdfe7c3
equal deleted inserted replaced
36853:9001df2d68e9 36959:d839463825a2
     1 /*
       
     2  * Copyright (c) 2011, 2012, 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 com.apple.eawt;
       
    27 
       
    28 import com.apple.eawt.AppEvent.QuitEvent;
       
    29 
       
    30 /**
       
    31  * An implementor determines if requests to quit this application should proceed or cancel.
       
    32  *
       
    33  * @see Application#setQuitHandler(QuitHandler)
       
    34  * @see Application#setQuitStrategy(QuitStrategy)
       
    35  *
       
    36  * @since Java for Mac OS X 10.6 Update 3
       
    37  * @since Java for Mac OS X 10.5 Update 8
       
    38  */
       
    39 public interface QuitHandler {
       
    40     /**
       
    41      * Invoked when the application is asked to quit.
       
    42      *
       
    43      * Implementors must call either {@link QuitResponse#cancelQuit()}, {@link QuitResponse#performQuit()}, or ensure the application terminates.
       
    44      * The process (or log-out) requesting this app to quit will be blocked until the {@link QuitResponse} is handled.
       
    45      * Apps that require complex UI to shutdown may call the {@link QuitResponse} from any thread.
       
    46      * Your app may be asked to quit multiple times before you have responded to the initial request.
       
    47      * This handler is called each time a quit is requested, and the same {@link QuitResponse} object is passed until it is handled.
       
    48      * Once used, the {@link QuitResponse} cannot be used again to change the decision.
       
    49      *
       
    50      * @param e the request to quit this application.
       
    51      * @param response the one-shot response object used to cancel or proceed with the quit action.
       
    52      */
       
    53     public void handleQuitRequestWith(final QuitEvent e, final QuitResponse response);
       
    54 }