me.vaperion.blade.platform.api

Class HelpGenerator.Default<T>

java.lang.Object

me.vaperion.blade.platform.api.HelpGenerator.Default<T>

All Implemented Interfaces:

HelpGenerator<T>

Enclosing interface:

HelpGenerator<Text>

public static final class HelpGenerator.Default<T>
extends java.lang.Object
implements HelpGenerator<T>

Nested Class Summary

Nested classes/interfaces inherited from interface me.vaperion.blade.platform.api.HelpGenerator

HelpGenerator.Default<T>

Field Summary

Fields inherited from interface me.vaperion.blade.platform.api.HelpGenerator

RESULTS_PER_PAGE

Constructor Summary

Constructors

Constructor and Description
Default()

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<T>	generate(@NotNull Context context, @NotNull java.util.List<BladeCommand> commands) Generates help text for the given list of commands within the provided context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.vaperion.blade.platform.api.HelpGenerator

filterCommands

Constructor Detail

Default

public Default()

Method Detail

generate

@NotNull
public @NotNull java.util.List<T> generate(@NotNull
                                                    @NotNull Context context,
                                                    @NotNull
                                                    @NotNull java.util.List<BladeCommand> commands)

Description copied from interface: HelpGenerator

Generates help text for the given list of commands within the provided context.

Specified by:

generate in interface HelpGenerator<T>

Parameters:

context - the context in which the help is generated

commands - the list of commands to generate help for

Returns:

a list of help text entries