com.rathravane.till.console.shell.command Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of silt Show documentation

A small collection of classes used in various Rathravane systems.

There is a newer version: 2.1.1

/*
 *	Copyright 2006-2012, Rathravane LLC
 *
 *	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 com.rathravane.till.console.shell;

import java.io.PrintStream;
import java.util.HashMap;

import com.rathravane.till.console.ConsoleProgram.usageException;
import com.rathravane.till.nv.rrNvReadable;

public interface command
{
	String getCommand ();

	/**
	 * check the arguments provided
	 * @param args
	 */
	void checkArgs ( rrNvReadable p, String[] args ) throws usageException;

	/**
	 * @return a string used for the help command to show simple usage
	 */
	String getUsage ();

	/**
	 * @return a string used for the help command to show detail info
	 */
	String getHelp ();

	/**
	 * @param outTo
	 * @return true to continue, false to exit
	 * @throws usageException 
	 */
	consoleLooper.inResult execute ( HashMap workspace, PrintStream outTo ) throws usageException;
}