com.github.rinde.rinsim.cli.HelpFormatter Maven / Gradle / Ivy
/*
* Copyright (C) 2011-2015 Rinde van Lon, iMinds-DistriNet, KU Leuven
*
* 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.github.rinde.rinsim.cli;
/**
* Implementations should create a formatted string containing all information
* about a menu.
* @author Rinde van Lon
*/
public interface HelpFormatter {
/**
* Creates a formatted help string.
* @param menu The menu to create the help for.
* @return A formatted string containing all help information of the specified
* menu.
*/
String format(Menu menu);
}