Package picocli.codegen.annotation.processing

Class CompileTimeTypeInfo

java.lang.Object

picocli.codegen.annotation.processing.CompileTimeTypeInfo

All Implemented Interfaces:

CommandLine.Model.ITypeInfo

class CompileTimeTypeInfo
extends java.lang.Object
implements CommandLine.Model.ITypeInfo

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.util.List<java.lang.String>	actualGenericTypeArguments
(package private) java.util.List<? extends javax.lang.model.type.TypeMirror>	auxTypeMirrors
(package private) boolean	isCollection
(package private) boolean	isMap
private static java.util.logging.Logger	logger
private static java.util.EnumSet<javax.lang.model.type.TypeKind>	PRIMITIVES
(package private) javax.lang.model.element.TypeElement	typeElement
(package private) javax.lang.model.type.TypeMirror	typeMirror

Constructor Summary

Constructors

Constructor	Description
CompileTimeTypeInfo(javax.lang.model.type.TypeMirror asType)

Method Summary

Modifier and Type	Method	Description
private javax.lang.model.type.TypeMirror	createStringTypeMirror()
private static boolean	find(java.lang.String interfaceName, javax.lang.model.element.TypeElement typeElement)
private static boolean	find(java.lang.String interfaceName, javax.lang.model.element.TypeElement typeElement, java.util.Set<javax.lang.model.element.Element> visited)
java.util.List<java.lang.String>	getActualGenericTypeArguments()	Returns the names of the type arguments if this is a generic type.
java.util.List<CommandLine.Model.ITypeInfo>	getAuxiliaryTypeInfos()	Returns type information of components or elements of a multivalue type.
java.lang.Class<?>[]	getAuxiliaryTypes()	Returns the component class of an array, or the parameter type of a generic Collection, or the parameter types of the key and the value of a generic Map.
java.lang.String	getClassName()	Returns the fully qualified class name (not the canonical name, but with $-signs for inner classes) of the typeElement.
java.lang.String	getClassSimpleName()
java.util.List<java.lang.String>	getEnumConstantNames()
java.lang.Class<?>	getType()	Returns the class that the option or parameter value should be converted to when matched on the command line.
boolean	isArray()
boolean	isBoolean()	Returns true if CommandLine.Model.ITypeInfo.getType() is boolean or java.lang.Boolean.
(package private) static boolean	isBooleanType(javax.lang.model.type.TypeMirror type)
boolean	isCollection()
boolean	isEnum()	Returns true if CommandLine.Model.ITypeInfo.getType() is an enum.
boolean	isMap()
boolean	isMultiValue()	Returns true if CommandLine.Model.ITypeInfo.getType() is an array, map or collection.
boolean	isOptional()	Returns true if CommandLine.Model.ITypeInfo.getType() is java.util.Optional
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static java.util.logging.Logger logger

PRIMITIVES

private static final java.util.EnumSet<javax.lang.model.type.TypeKind> PRIMITIVES

typeMirror

final javax.lang.model.type.TypeMirror typeMirror

auxTypeMirrors

final java.util.List<? extends javax.lang.model.type.TypeMirror> auxTypeMirrors

actualGenericTypeArguments

final java.util.List<java.lang.String> actualGenericTypeArguments

typeElement

final javax.lang.model.element.TypeElement typeElement

isCollection

final boolean isCollection

isMap

final boolean isMap

Constructor Detail

CompileTimeTypeInfo

public CompileTimeTypeInfo(javax.lang.model.type.TypeMirror asType)

Method Detail

createStringTypeMirror

private javax.lang.model.type.TypeMirror createStringTypeMirror()

find

private static boolean find(java.lang.String interfaceName,
                            javax.lang.model.element.TypeElement typeElement)

find

private static boolean find(java.lang.String interfaceName,
                            javax.lang.model.element.TypeElement typeElement,
                            java.util.Set<javax.lang.model.element.Element> visited)

getAuxiliaryTypeInfos

public java.util.List<CommandLine.Model.ITypeInfo> getAuxiliaryTypeInfos()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns type information of components or elements of a multivalue type.

Specified by:

getAuxiliaryTypeInfos in interface CommandLine.Model.ITypeInfo

getActualGenericTypeArguments

public java.util.List<java.lang.String> getActualGenericTypeArguments()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns the names of the type arguments if this is a generic type. For example, returns ["java.lang.String"] if this type is List<String>.

Specified by:

getActualGenericTypeArguments in interface CommandLine.Model.ITypeInfo

isBoolean

public boolean isBoolean()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns true if CommandLine.Model.ITypeInfo.getType() is boolean or java.lang.Boolean.

Specified by:

isBoolean in interface CommandLine.Model.ITypeInfo

isBooleanType

static boolean isBooleanType(javax.lang.model.type.TypeMirror type)

isOptional

public boolean isOptional()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns true if CommandLine.Model.ITypeInfo.getType() is java.util.Optional

Specified by:

isOptional in interface CommandLine.Model.ITypeInfo

isMultiValue

public boolean isMultiValue()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns true if CommandLine.Model.ITypeInfo.getType() is an array, map or collection.

Specified by:

isMultiValue in interface CommandLine.Model.ITypeInfo

isArray

public boolean isArray()

Specified by:

isArray in interface CommandLine.Model.ITypeInfo

isCollection

public boolean isCollection()

Specified by:

isCollection in interface CommandLine.Model.ITypeInfo

isMap

public boolean isMap()

Specified by:

isMap in interface CommandLine.Model.ITypeInfo

isEnum

public boolean isEnum()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns true if CommandLine.Model.ITypeInfo.getType() is an enum.

Specified by:

isEnum in interface CommandLine.Model.ITypeInfo

getEnumConstantNames

public java.util.List<java.lang.String> getEnumConstantNames()

Specified by:

getEnumConstantNames in interface CommandLine.Model.ITypeInfo

getClassName

public java.lang.String getClassName()

Returns the fully qualified class name (not the canonical name, but with $-signs for inner classes) of the typeElement. If only a typeMirror is available, this method falls back to TypeMirror.toString, which returns the canonical name.

Specified by:

getClassName in interface CommandLine.Model.ITypeInfo

Returns:

the fully qualified class name of the type

getClassSimpleName

public java.lang.String getClassSimpleName()

Specified by:

getClassSimpleName in interface CommandLine.Model.ITypeInfo

getType

public java.lang.Class<?> getType()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns the class that the option or parameter value should be converted to when matched on the command line. This method is not safe for annotation processors to use.

Specified by:

getType in interface CommandLine.Model.ITypeInfo

Returns:

the class that the option or parameter value should be converted to

getAuxiliaryTypes

public java.lang.Class<?>[] getAuxiliaryTypes()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns the component class of an array, or the parameter type of a generic Collection, or the parameter types of the key and the value of a generic Map. This method is not safe for annotation processors to use.

Specified by:

getAuxiliaryTypes in interface CommandLine.Model.ITypeInfo

Returns:

the component type or types of an array, Collection or Map type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object