org.jsimpledb.cli.cmd.Command Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsimpledb-cli Show documentation

JSimpleDB classes supporting command line interfaces.

The newest version!


/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package org.jsimpledb.cli.cmd;

import java.util.EnumSet;

import org.jsimpledb.SessionMode;
import org.jsimpledb.cli.CliSession;
import org.jsimpledb.parse.Parser;

/**
 * {@link org.jsimpledb.cli.CliSession} command.
 *
 * @see AbstractCommand
 */
public interface Command extends Parser {

    /**
     * Get the name of this command.
     *
     * @return command name
     */
    String getName();

    /**
     * Get command usage string.
     *
     * @return command usage string
     */
    String getUsage();

    /**
     * Get summarized help (typically a single line).
     *
     * @return one line command summary
     */
    String getHelpSummary();

    /**
     * Get expanded help (typically multiple lines).
     *
     * @return detailed command description
     */
    String getHelpDetail();

    /**
     * Get the {@link SessionMode}(s) supported by this command.
     *
     * @return set of supported {@link SessionMode}s
     */
    EnumSet getSessionModes();
}