Command.java

/**
 * OpenSpotLight - Open Source IT Governance Platform
 *
 * Copyright (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA
 * or third-party contributors as indicated by the @author tags or express
 * copyright attribution statements applied by the authors.  All third-party
 * contributions are distributed under license by CARAVELATECH CONSULTORIA E
 * TECNOLOGIA EM INFORMATICA LTDA.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU Lesser General Public License  for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 ***********************************************************************
 * OpenSpotLight - Plataforma de Governança de TI de Código Aberto
 *
 * Direitos Autorais Reservados (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA
 * EM INFORMATICA LTDA ou como contribuidores terceiros indicados pela etiqueta
 * @author ou por expressa atribuição de direito autoral declarada e atribuída pelo autor.
 * Todas as contribuições de terceiros estão distribuídas sob licença da
 * CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA.
 *
 * Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo sob os
 * termos da Licença Pública Geral Menor do GNU conforme publicada pela Free Software
 * Foundation.
 *
 * Este programa é distribuído na expectativa de que seja útil, porém, SEM NENHUMA
 * GARANTIA; nem mesmo a garantia implícita de COMERCIABILIDADE OU ADEQUAÇÃO A UMA
 * FINALIDADE ESPECÍFICA. Consulte a Licença Pública Geral Menor do GNU para mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral Menor do GNU junto com este
 * programa; se não, escreva para:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.openspotlight.graph.query.console.command;

import java.io.PrintWriter;

import jline.ConsoleReader;

import org.openspotlight.graph.query.console.ConsoleState;

/**
 * The Interface Command.
 * 
 * @author porcelli
 */
public interface Command {

    /**
     * The Enum FileCompletionMode.
     * 
     * @author porcelli
     */
    public enum FileCompletionMode {

        /** The CONTAINS mode. */
        CONTAINS,

        /** The STARTS_WITH mode. */
        STARTS_WITH
    }

    /**
     * Accept.
     * 
     * @param state the state
     * @return true, if successful
     */
    public boolean accept(ConsoleState state);

    /**
     * Execute.
     * 
     * @param reader the reader
     * @param out the out
     * @param state the state
     */
    public void execute(ConsoleReader reader,
                         PrintWriter out,
                         ConsoleState state);

    /**
     * Gets the auto complete command.
     * 
     * @return the auto complete command
     */
    public String getAutoCompleteCommand();

    /**
     * Gets the console command.
     * 
     * @return the console command
     */
    public String getCommand();

    /**
     * Gets the description. This will be printed at help statement.
     * 
     * @return the description
     */
    public String getDescription();

    /**
     * Gets the file completion command.
     * 
     * @return the file completion command
     */
    public String getFileCompletionCommand();

    /**
     * Gets the file completion mode.
     * 
     * @return the file completion mode
     */
    public FileCompletionMode getFileCompletionMode();

    /**
     * Checks if Command supports file completion.
     * 
     * @return true, if successful
     */
    public boolean hasFileCompletion();

}