org.jboss.aesh.cl.populator

Class AeshCommandPopulator

java.lang.Object

org.jboss.aesh.cl.populator.AeshCommandPopulator

All Implemented Interfaces:

CommandPopulator<java.lang.Object,Command>

public class AeshCommandPopulator
extends java.lang.Object
implements CommandPopulator<java.lang.Object,Command>

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	instance

Constructor Summary

Constructors

Constructor and Description
AeshCommandPopulator(java.lang.Object instance)

Method Summary

Modifier and Type	Method and Description
private java.lang.reflect.Field	getField(java.lang.Class clazz, java.lang.String fieldName)
java.lang.Object	getObject()
void	populateObject(CommandLine<Command> line, InvocationProviders invocationProviders, AeshContext aeshContext, boolean validate) Populate a Command instance with the values parsed from a command line If any parser errors are detected it will throw an exception
private void	resetField(java.lang.Object instance, java.lang.String fieldName, boolean hasValue) Will parse the input line and populate the fields in the instance object specified by the given annotations.

Methods inherited from class java.lang.Object

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

Field Detail

instance

private final java.lang.Object instance

Constructor Detail

AeshCommandPopulator

public AeshCommandPopulator(java.lang.Object instance)

Method Detail

populateObject

public void populateObject(CommandLine<Command> line,
                           InvocationProviders invocationProviders,
                           AeshContext aeshContext,
                           boolean validate)
                    throws CommandLineParserException,
                           OptionValidatorException

Populate a Command instance with the values parsed from a command line If any parser errors are detected it will throw an exception

Specified by:

populateObject in interface CommandPopulator<java.lang.Object,Command>

Parameters:

line - command line

validate - do validation or not

aeshContext - the context

Throws:

CommandLineParserException

OptionValidatorException

resetField

private void resetField(java.lang.Object instance,
                        java.lang.String fieldName,
                        boolean hasValue)

Will parse the input line and populate the fields in the instance object specified by the given annotations. The instance object must be annotated with the CommandDefinition annotation @see CommandDefinition Any parser errors will throw an exception

Parameters:

instance - command

fieldName - field public static void parseAndPopulate(Object instance, String line) throws CommandLineParserException, OptionValidatorException { CommandLineParser parser = ParserGenerator.generateCommandLineParser(instance.getClass()); AeshCommandPopulator populator = new AeshCommandPopulator(parser); populator.populateObject(instance, parser.parse(line)); }

getField

private java.lang.reflect.Field getField(java.lang.Class clazz,
                                         java.lang.String fieldName)
                                  throws java.lang.NoSuchFieldException

Throws:

java.lang.NoSuchFieldException

getObject

public java.lang.Object getObject()

Specified by:

getObject in interface CommandPopulator<java.lang.Object,Command>

Returns:

the object instance that will be populated.