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     * An interactive console-based menu.
033     *
034     * @param <T>
035     *          The type of success result value(s) returned by the
036     *          call-back. Use <code>Void</code> if the call-backs do
037     *          not return any values.
038     */
039    public interface Menu<T> {
040    
041      /**
042       * Displays the menu and waits for the user to select a valid
043       * option. When the user selects an option, the call-back associated
044       * with the option will be invoked and its result returned.
045       *
046       * @return Returns the result of invoking the chosen menu call-back.
047       * @throws CLIException
048       *           If an I/O exception occurred or if one of the menu
049       *           option call-backs failed for some reason.
050       */
051      MenuResult<T> run() throws CLIException;
052    }