org.hyperic.sigar.shell.ShellCommandHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sigar-loader Show documentation

sigar-loader

There is a newer version: 1.6.6-rev002

/*
 * Copyright (c) 2006 Hyperic, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.hyperic.sigar.shell;

public interface ShellCommandHandler {

    /**
     * Initialize this command handler.
     * @param commandName The name of the command.
     * @param shell The shell.  This is useful for command
     * that need to be able to interpret other commands, like the "help" 
     * command, and for commands that need to get additional user input,
     * for example a login command that presents a password prompt.
     */
    public void init(String commandName, ShellBase shell)
        throws ShellCommandInitException;

    /**
     * Handle a command.
     * @param args The args to the command.
     * @exception ShellCommandUsageException If the args are malformed.
     * @exception ShellCommandExecException If an error occurred
     * executing the command.
     */
    public void processCommand(String[] args)
        throws ShellCommandUsageException, ShellCommandExecException;

    /**
     * Get some info on how to invoke this command.
     * @return Some usage information on how this command is 
     * expected to be invoked.
     */
    public String getUsageHelp(String[] args);

    /**
     * Get a very brief (40 character) description of the command
     * @return A description of the command.
     */
    public String getUsageShort();

    /**
     * Get a description of the syntax for how a command should be invoked.
     * @return A description of the syntax
     */
    public String getSyntax();
}