com.github.rvesse.airline.model

Class MetadataLoader

java.lang.Object

com.github.rvesse.airline.model.MetadataLoader

public class MetadataLoader
extends Object

Helper for loading meta-data

Constructor Summary

Constructors

Constructor and Description
MetadataLoader()

Method Summary

Modifier and Type	Method and Description
protected static void	buildGroupsHierarchy(List<CommandGroupMetadata> commandGroups, Map<String,CommandGroupMetadata> subGroups)
static CommandMetadata	loadCommand(Class<?> commandType) Loads command meta-data
static CommandMetadata	loadCommand(Class<?> commandType, Map<String,HelpSection> baseHelpSections) Loads command meta-data
static CommandGroupMetadata	loadCommandGroup(String name, String description, boolean hidden, Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, Iterable<CommandMetadata> commands) Loads command group meta-data
static <T> List<CommandMetadata>	loadCommands(Iterable<Class<? extends T>> defaultCommands, Map<String,HelpSection> baseHelpSections) Loads command meta-data
static void	loadCommandsIntoGroupsByAnnotation(List<CommandMetadata> allCommands, List<CommandGroupMetadata> commandGroups, List<CommandMetadata> defaultCommandGroup, Map<String,HelpSection> baseHelpSections)
static <C> GlobalMetadata<C>	loadGlobal(Class<?> cliClass)
static <C> GlobalMetadata<C>	loadGlobal(Class<?> cliClass, ParserMetadata<C> parserConfigOverride) Loads the metadata for a CLI
static <C> GlobalMetadata<C>	loadGlobal(String name, String description, CommandMetadata defaultCommand, Iterable<CommandMetadata> defaultGroupCommands, Iterable<CommandGroupMetadata> groups, Iterable<GlobalRestriction> restrictions, Iterable<HelpSection> baseHelpSections, ParserMetadata<C> parserConfig) Loads global meta-data
protected static Map<String,HelpSection>	loadHelpSections(Class<?> sourceClass, Map<String,HelpSection> baseHelpSections)
static com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata	loadInjectionMetadata(Class<?> type) Loads injection meta-data
static void	loadInjectionMetadata(Class<?> type, com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata injectionMetadata, List<Field> fields) Loads injection meta-data
static <C> ParserMetadata<C>	loadParser(Class<?> cliClass)
static SuggesterMetadata	loadSuggester(Class<? extends Suggester> suggesterClass) Loads suggester meta-data

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataLoader

public MetadataLoader()

Method Detail

loadParser

public static <C> ParserMetadata<C> loadParser(Class<?> cliClass)

loadGlobal

public static <C> GlobalMetadata<C> loadGlobal(Class<?> cliClass)

loadGlobal

public static <C> GlobalMetadata<C> loadGlobal(Class<?> cliClass,
                                               ParserMetadata<C> parserConfigOverride)

Loads the metadata for a CLI

Parameters:

cliClass - Class that has the Cli annotation

parserConfigOverride - Optional parser configuration, note that the Cli.parserConfiguration() field is normally used to provide a parser configuration via annotation but in some situations this may not be possible, e.g. constructing user alias search paths programmatically, in which case providing a parser configuration here overrides anything specified directly on the annotation

Returns:

Global metadata

loadGlobal

public static <C> GlobalMetadata<C> loadGlobal(String name,
                                               String description,
                                               CommandMetadata defaultCommand,
                                               Iterable<CommandMetadata> defaultGroupCommands,
                                               Iterable<CommandGroupMetadata> groups,
                                               Iterable<GlobalRestriction> restrictions,
                                               Iterable<HelpSection> baseHelpSections,
                                               ParserMetadata<C> parserConfig)

Loads global meta-data

Parameters:

name - CLI name

description - CLI description

defaultCommand - Default Command

defaultGroupCommands - Default Group Commands

groups - Command Groups

parserConfig - Parser Configuration

restrictions - Restrictions

baseHelpSections - Base help sections

Returns:

Global meta-data

loadCommandGroup

public static CommandGroupMetadata loadCommandGroup(String name,
                                                    String description,
                                                    boolean hidden,
                                                    Iterable<CommandGroupMetadata> subGroups,
                                                    CommandMetadata defaultCommand,
                                                    Iterable<CommandMetadata> commands)

Loads command group meta-data

Parameters:

name - Group name

description - Group description

hidden - Whether the group is hidden

defaultCommand - Default command for the group

commands - Commands for the group

Returns:

Command group meta-data

loadCommands

public static <T> List<CommandMetadata> loadCommands(Iterable<Class<? extends T>> defaultCommands,
                                                     Map<String,HelpSection> baseHelpSections)

Loads command meta-data

Parameters:

defaultCommands - Default command classes

Returns:

Command meta-data

loadCommand

public static CommandMetadata loadCommand(Class<?> commandType)

Loads command meta-data

Parameters:

commandType - Command class

Returns:

Command meta-data

loadCommand

public static CommandMetadata loadCommand(Class<?> commandType,
                                          Map<String,HelpSection> baseHelpSections)

Loads command meta-data

Parameters:

commandType - Command Type

baseHelpSections - Base set of help sections

Returns:

Command meta-data

loadHelpSections

protected static Map<String,HelpSection> loadHelpSections(Class<?> sourceClass,
                                                          Map<String,HelpSection> baseHelpSections)

loadSuggester

public static SuggesterMetadata loadSuggester(Class<? extends Suggester> suggesterClass)

Loads suggester meta-data

Parameters:

suggesterClass - Suggester class

Returns:

Suggester meta-data

loadInjectionMetadata

public static com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata loadInjectionMetadata(Class<?> type)

Loads injection meta-data

Parameters:

type - Class

Returns:

Injection meta-data

loadInjectionMetadata

public static void loadInjectionMetadata(Class<?> type,
                                         com.github.rvesse.airline.model.MetadataLoader.InjectionMetadata injectionMetadata,
                                         List<Field> fields)

Loads injection meta-data

Parameters:

type - Class

injectionMetadata - Injection meta-data

fields - Fields

loadCommandsIntoGroupsByAnnotation

public static void loadCommandsIntoGroupsByAnnotation(List<CommandMetadata> allCommands,
                                                      List<CommandGroupMetadata> commandGroups,
                                                      List<CommandMetadata> defaultCommandGroup,
                                                      Map<String,HelpSection> baseHelpSections)

buildGroupsHierarchy

protected static void buildGroupsHierarchy(List<CommandGroupMetadata> commandGroups,
                                           Map<String,CommandGroupMetadata> subGroups)