001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.util.cli;
028    
029    
030    
031    /**
032     * A menu call-back which should be associated with each menu option.
033     * When an option is selected the call-back is invoked.
034     *
035     * @param <T>
036     *          The type of success result value(s) returned by the
037     *          call-back. Use <code>Void</code> if the call-backs do
038     *          not return any values.
039     */
040    public interface MenuCallback<T> {
041    
042      /**
043       * Invoke the menu call-back.
044       *
045       * @param app
046       *          The application console.
047       * @return Returns the result of invoking the menu call-back.
048       * @throws CLIException
049       *           If the menu call-back fails for some reason.
050       */
051      MenuResult<T> invoke(ConsoleApplication app) throws CLIException;
052    }