Package picocli.codegen.annotation.processing

Class VersionProviderMetaData

java.lang.Object

picocli.codegen.annotation.processing.VersionProviderMetaData

All Implemented Interfaces:

ITypeMetaData, CommandLine.IVersionProvider

class VersionProviderMetaData
extends java.lang.Object
implements CommandLine.IVersionProvider, ITypeMetaData

Implementation of the CommandLine.IVersionProvider interface that provides metadata on the @Command(versionProvider = 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
VersionProviderMetaData()
VersionProviderMetaData(javax.lang.model.type.TypeMirror typeMirror)

Method Summary

Modifier and Type	Method	Description
javax.lang.model.element.TypeElement	getTypeElement()	Returns the TypeElement of the type mirror.
javax.lang.model.type.TypeMirror	getTypeMirror()	Returns the TypeMirror that this VersionProviderMetaData was constructed with.
java.lang.String[]	getVersion()	Always returns an empty array.
static void	initVersionProvider(CommandLine.Model.CommandSpec result, CommandLine.Command cmd)	Sets the specified CommandSpec's CommandLine.Model.CommandSpec.versionProvider(picocli.CommandLine.IVersionProvider) version provider} to a VersionProviderMetaData instance if the annotation attribute was present on the specified Command annotation.
boolean	isDefault()	Returns true if the command did not have a versionProvider 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

VersionProviderMetaData

public VersionProviderMetaData()

VersionProviderMetaData

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

Method Detail

initVersionProvider

public static void initVersionProvider(CommandLine.Model.CommandSpec result,
                                       CommandLine.Command cmd)

Sets the specified CommandSpec's CommandLine.Model.CommandSpec.versionProvider(picocli.CommandLine.IVersionProvider) version provider} to a VersionProviderMetaData instance if the annotation attribute was present on the specified Command annotation.

Parameters:

result - the command spec to initialize

cmd - the @Command annotation to inspect

isDefault

public boolean isDefault()

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

Specified by:

isDefault in interface ITypeMetaData

Returns:

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

getTypeMirror

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

Returns the TypeMirror that this VersionProviderMetaData was constructed with.

Specified by:

getTypeMirror in interface ITypeMetaData

Returns:

the TypeMirror of the @Command(versionProvider = 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

getVersion

public java.lang.String[] getVersion()

Always returns an empty array.

Specified by:

getVersion in interface CommandLine.IVersionProvider

Returns:

version information (each string in the array is displayed on a separate line)

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