001/*
002 * (C) Copyright 2006-2010 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     bstefanescu
016 */
017package org.nuxeo.shell.cmds;
018
019/**
020 * Give a chance to embedded shells to do some customization before shell is started and when exit is required.
021 * <p>
022 * This is currently used by shell applet to correctly handle start and stop.
023 *
024 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
025 */
026public interface InteractiveShellHandler {
027
028    /**
029     * Interactive shell will be started.
030     */
031    void enterInteractiveMode();
032
033    /**
034     * Interactive shell should be disposed. This method should dispose the current session. If no handler is defined
035     * the Java process will exit with the given code (if <= 0 - normal exit, otherwise an exit with given code is
036     * performed). Return true to exit the shell loop, false otherwise.
037     *
038     * @param code
039     */
040    boolean exitInteractiveMode(int code);
041
042}