karaf/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/commands/CommandHelpPrinter.java

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements. See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership. The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License. You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing,
  13  * software distributed under the License is distributed on an
  14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15  * KIND, either express or implied. See the License for the
  16  * specific language governing permissions and limitations
  17  * under the License.
  18  */
  19 package org.apache.karaf.tooling.commands;
  20
  21 import java.io.PrintStream;
  22 import java.util.Map;
  23 import java.util.Set;
  24
  25 import org.apache.karaf.shell.api.action.Action;
  26
  27 public interface CommandHelpPrinter {
  28
  29     /**
  30      * Print help for a single action to the out stream
  31      *
  32      * @param action
  33      * @param out stream to write to
  34      * @param includeHelpOption include the help option in the doc
  35      */
  36     void printHelp(Action action, PrintStream out, boolean includeHelpOption);
  37
  38     /**
  39      * Print the overview of all given commands to the out stream
  40      *
  41      * @param commands
  42      * @param out
  43      */
  44     void printOverview(Map<String, Set<String>> commands, PrintStream out);
  45
  46 }