001 /*
002 * Copyright (C) 2012 eXo Platform SAS.
003 *
004 * This is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU Lesser General Public License as
006 * published by the Free Software Foundation; either version 2.1 of
007 * the License, or (at your option) any later version.
008 *
009 * This software 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 * You should have received a copy of the GNU Lesser General Public
015 * License along with this software; if not, write to the Free
016 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018 */
019
020 package org.crsh.cli.spi;
021
022 import org.crsh.cli.descriptor.ParameterDescriptor;
023
024 public interface Completer {
025
026 /**
027 * <p>Query the completer for a set of completions for the given prefix. The returned {@link Completion} object
028 * provides the possible completion matching the prefix argument.<p>
029 *
030 * @param parameter the completed parameter
031 * @param prefix the prefix to complete
032 * @return the possible suffix map
033 * @throws Exception any exception that would prevent completion to perform correctly
034 */
035 Completion complete(ParameterDescriptor parameter, String prefix) throws Exception;
036
037 }