net.sf.mmm.util.cli.api

Interface CliParserBuilder

All Known Implementing Classes:

AbstractCliParserBuilder, DefaultCliParserBuilder

@ComponentSpecification
public interface CliParserBuilder

This is the interface used to build a CliParser from a given object.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
CliParser	build(Object pojo) This method builds a CliParser instance from the given Pojo.

Method Detail

build

CliParser build(Object pojo)

This method builds a CliParser instance from the given Pojo. The following applies for the class reflecting this pojo:

• it needs to have (declared or inherited) fields annotated with CliOption and / or CliArgument.
• It's class or one of it's super-classes may also be annotated with CliClass.
• It is recommended to use the main-program itself, but it can be any Pojo.

Parameters:

pojo - is the annotated object for the CLI-state.

Returns:

the CliParser used to parse the commandline-arguments and potentially print the help.