AbstractCommand.java

/*******************************************************************************
 * Copyright (c) 2008, 2009 Bug Labs, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    - Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *    - Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    - Neither the name of Bug Labs, Inc. nor the names of its contributors may be
 *      used to endorse or promote products derived from this software without
 *      specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
package com.buglabs.osgi.shell.pub;

import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.util.ArrayList;
import java.util.List;

import org.osgi.framework.BundleContext;

import com.buglabs.osgi.shell.ICommand;
import com.buglabs.tableviewer.IRowFilter;
import com.buglabs.tableviewer.TableViewer;

/**
 * A helper base class for commands for the command line. Refer to ICommand for
 * details of how to write commands for OSGi shell.
 * 
 * @author kgilmer
 * 
 */
public abstract class AbstractCommand implements ICommand {

	protected List arguments;

	protected BufferedWriter outWriter;

	protected OutputStream err;

	protected BundleContext context;

	protected OutputStream out;

	public void initialize(List arguments, OutputStream out, OutputStream err, BundleContext context) {
		this.out = out;
		if (arguments != null) {
			this.arguments = arguments;
		} else {
			this.arguments = new ArrayList();
		}

		this.outWriter = new BufferedWriter(new OutputStreamWriter(out));
		this.err = err;
		this.context = context;

	}

	/**
	 * Print message to error stream.
	 * 
	 * @param message
	 * @throws IOException
	 */
	protected void printError(String message) throws IOException {
		err.write(message.getBytes());
		err.flush();
	}

	/**
	 * Print line to standard out.
	 * 
	 * @param message
	 * @throws IOException
	 */
	protected void println(String message) throws IOException {
		outWriter.write(message + "\n");
		outWriter.flush();
	}

	/* (non-Javadoc)
	 * @see com.buglabs.osgi.shell.ICommand#isValid()
	 */
	public boolean isValid() {
		return true;
	}

	public String getUsage() {
		return "";
	}

	public String getDescription() {
		return "No help available for this command.";
	}

	protected void setDefaultFilter(TableViewer tv, int position) {
		if (arguments != null && arguments.size() == position) {
			tv.setFilter(new IRowFilter() {

				public boolean isMatch(String rowText) {
					// case insensitive match
					if (rowText.toUpperCase().indexOf(((String) arguments.get(0)).toUpperCase()) > -1) {
						return true;
					}

					return false;
				}

			});
		}
	}
}