tools/shell/src/main/java/org/apache/zest/tools/shell/help/HelpCommand.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.zest.tools.shell.help;

import java.io.BufferedReader;
import java.io.PrintWriter;
import org.apache.zest.tools.shell.AbstractCommand;
import org.apache.zest.tools.shell.Command;

public class HelpCommand extends AbstractCommand
{
    private Iterable<Command> commands;

    public HelpCommand()
    {
    }

    public void setCommands( Iterable<Command> comands )
    {
        this.commands = commands;
    }

    @Override
    public void execute( String[] args, BufferedReader input, PrintWriter output )
    {
        for( Command command : commands )
        {
            output.println( command.name() + "\t" + command.description() );
        }
    }

    @Override
    public String description()
    {
        return "help";
    }

    @Override
    public String name()
    {
        return "Prints this help text.";
    }
}