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 /**
  29  * Used to respond to a request to quit the application.
  30  * The QuitResponse may be used after the {@link QuitHandler#handleQuitRequestWith(AppEvent.QuitEvent, QuitResponse)} method has returned, and may be used from any thread.
  31  *
  32  * @see Application#setQuitHandler(QuitHandler)
  33  * @see 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 class QuitResponse {
  40     final _AppEventHandler appEventHandler;
  41 
  42     QuitResponse(final _AppEventHandler appEventHandler) {
  43         this.appEventHandler = appEventHandler;
  44     }
  45 
  46     /**
  47      * Notifies the external quit requester that the quit will proceed, and performs the default {@link QuitStrategy}.
  48      */
  49     public void performQuit() {
  50         if (appEventHandler.currentQuitResponse != this) return;
  51         appEventHandler.performQuit();
  52     }
  53 
  54     /**
  55      * Notifies the external quit requester that the user has explicitly canceled the pending quit, and leaves the application running.
  56      * <b>Note: this will cancel a pending log-out, restart, or shutdown.</b>
  57      */
  58     public void cancelQuit() {
  59         if (appEventHandler.currentQuitResponse != this) return;
  60         appEventHandler.cancelQuit();
  61     }
  62 }