Skip to content

Package io.github.qishr.cascara.common.util

Interface IHelpFactory

java.lang.Object
        io.github.qishr.cascara.common.util.CommandLine.IHelpFactory

Enclosing Class:
    io.github.qishr.cascara.common.util.CommandLine


public static interface IHelpFactory

Creates the Help instance used to render the usage help message.

Method Summary

Modifier and Type Method Description
public abstract Help create(CommandSpec commandSpec, ColorScheme colorScheme) Returns a Help instance to assist in rendering the usage help message

Method Details

create

public abstract Help create(CommandSpec commandSpec, ColorScheme colorScheme)

Returns a Help instance to assist in rendering the usage help message

Parameters:

commandSpec - the command to create usage help for

colorScheme - the color scheme to use when rendering usage help

Returns:

a Help instance