Package picocli.codegen.annotation.processing

Class ParameterConsumerMetaData

java.lang.Object

picocli.codegen.annotation.processing.ParameterConsumerMetaData

All Implemented Interfaces:

ITypeMetaData, CommandLine.IParameterConsumer

class ParameterConsumerMetaData
extends java.lang.Object
implements CommandLine.IParameterConsumer, ITypeMetaData

Implementation of the CommandLine.IParameterConsumer interface that provides metadata on the @Option(parameterConsumer = xxx.class) annotation.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private javax.lang.model.type.TypeMirror	typeMirror

Constructor Summary

Constructors

Constructor	Description
ParameterConsumerMetaData(javax.lang.model.type.TypeMirror typeMirror)

Method Summary

Modifier and Type	Method	Description
void	consumeParameters(java.util.Stack<java.lang.String> args, CommandLine.Model.ArgSpec argSpec, CommandLine.Model.CommandSpec commandSpec)	Does nothing.
static ParameterConsumerMetaData	extract(javax.lang.model.element.Element element)	Returns the type converters from the annotations present on the specified element.
javax.lang.model.element.TypeElement	getTypeElement()	Returns the TypeElement of the type mirror.
javax.lang.model.type.TypeMirror	getTypeMirror()	Returns the TypeMirror that this TypeConverterMetaData was constructed with.
boolean	isDefault()	Returns true if the command did not have a typeConverter annotation attribute.
java.lang.String	toString()	Returns a string representation of this object, for debugging purposes.

Methods inherited from class java.lang.Object

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

Field Detail

typeMirror

private final javax.lang.model.type.TypeMirror typeMirror

Constructor Detail

ParameterConsumerMetaData

public ParameterConsumerMetaData(javax.lang.model.type.TypeMirror typeMirror)

Method Detail

extract

public static ParameterConsumerMetaData extract(javax.lang.model.element.Element element)

Returns the type converters from the annotations present on the specified element.

Parameters:

element - the method or field annotated with @Option or @Parameters

Returns:

the type converters or an empty array if not found

isDefault

public boolean isDefault()

Returns true if the command did not have a typeConverter annotation attribute.

Specified by:

isDefault in interface ITypeMetaData

Returns:

true if the command did not have a typeConverter annotation attribute.

getTypeMirror

public javax.lang.model.type.TypeMirror getTypeMirror()

Returns the TypeMirror that this TypeConverterMetaData was constructed with.

Specified by:

getTypeMirror in interface ITypeMetaData

Returns:

the TypeMirror of the @Command(typeConverter = xxx.class) annotation.

getTypeElement

public javax.lang.model.element.TypeElement getTypeElement()

Description copied from interface: ITypeMetaData

Returns the TypeElement of the type mirror.

Specified by:

getTypeElement in interface ITypeMetaData

Returns:

the type mirror as a TypeElement

consumeParameters

public void consumeParameters(java.util.Stack<java.lang.String> args,
                              CommandLine.Model.ArgSpec argSpec,
                              CommandLine.Model.CommandSpec commandSpec)

Does nothing.

Specified by:

consumeParameters in interface CommandLine.IParameterConsumer

Parameters:

args - the command line arguments

argSpec - the option or positional parameter for which to consume command line arguments

commandSpec - the command that the option or positional parameter belongs to

toString

public java.lang.String toString()

Returns a string representation of this object, for debugging purposes.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this object