Package picocli

Class CommandLine.Model.RuntimeTypeInfo

java.lang.Object

picocli.CommandLine.Model.RuntimeTypeInfo

All Implemented Interfaces:

CommandLine.Model.ITypeInfo

Enclosing class:

CommandLine.Model

static class CommandLine.Model.RuntimeTypeInfo
extends Object
implements CommandLine.Model.ITypeInfo

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	actualGenericTypeArguments
private final Class<?>[]	auxiliaryTypes
(package private) static final String	ERRORMSG
private final Class<?>	type

Constructor Summary

Constructors

Constructor	Description
RuntimeTypeInfo(Class<?> type, Class<?>[] auxiliaryTypes, List<String> actualGenericTypeArguments)

Method Summary

Modifier and Type	Method	Description
static CommandLine.Model.ITypeInfo	create(Class<?> type, Class<?>[] annotationTypes, Type genericType, CommandLine.Range arity, Class<?> defaultType, boolean interactive)
static CommandLine.Model.ITypeInfo	create(Class<?> type, Class<?>[] auxiliaryTypes, List<String> actualGenericTypeArguments, CommandLine.Range arity, Class<?> defaultType, boolean interactive)
(package private) static CommandLine.Model.ITypeInfo	createForAuxType(Class<?> type)
boolean	equals(Object obj)
(package private) static Class<?>[]	extractTypeParameters(ParameterizedType genericType)
List<String>	getActualGenericTypeArguments()	Returns the names of the type arguments if this is a generic type.
List<CommandLine.Model.ITypeInfo>	getAuxiliaryTypeInfos()	Returns type information of components or elements of a multivalue type.
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.
String	getClassName()
String	getClassSimpleName()
List<String>	getEnumConstantNames()
Class<?>	getType()	Returns the class that the option or parameter value should be converted to when matched on the command line.
int	hashCode()
(package private) static Class<?>[]	inferTypes(Class<?> propertyType, Class<?>[] annotationTypes, Type genericType)
boolean	isArray()	Returns true if this type is an array multi-value type.
boolean	isBoolean()	Returns true if CommandLine.Model.ITypeInfo.getType() is boolean or java.lang.Boolean.
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
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ERRORMSG

static final String ERRORMSG

See Also:

• Constant Field Values

type

private final Class<?> type

auxiliaryTypes

private final Class<?>[] auxiliaryTypes

actualGenericTypeArguments

private final List<String> actualGenericTypeArguments

Constructor Details

RuntimeTypeInfo

RuntimeTypeInfo(Class<?> type,
 Class<?>[] auxiliaryTypes,
 List<String> actualGenericTypeArguments)

Method Details

createForAuxType

static CommandLine.Model.ITypeInfo createForAuxType(Class<?> type)

create

public static CommandLine.Model.ITypeInfo create(Class<?> type,
 Class<?>[] annotationTypes,
 Type genericType,
 CommandLine.Range arity,
 Class<?> defaultType,
 boolean interactive)

create

public static CommandLine.Model.ITypeInfo create(Class<?> type,
 Class<?>[] auxiliaryTypes,
 List<String> actualGenericTypeArguments,
 CommandLine.Range arity,
 Class<?> defaultType,
 boolean interactive)

inferTypes

static Class<?>[] inferTypes(Class<?> propertyType,
 Class<?>[] annotationTypes,
 Type genericType)

extractTypeParameters

static Class<?>[] extractTypeParameters(ParameterizedType genericType)

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

isMultiValue

public boolean isMultiValue()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns true if CommandLine.Model.ITypeInfo.getType() is an array, map or collection. Note that from picocli 4.7, char[] arrays are considered single values (similar to String) and are not treated as arrays.

Specified by:

isMultiValue in interface CommandLine.Model.ITypeInfo

isArray

public boolean isArray()

Description copied from interface: CommandLine.Model.ITypeInfo

Returns true if this type is an array multi-value type. Note that from picocli 4.7, char[] arrays are considered single values (similar to String) and are not treated as arrays.

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

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

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

getClassName

public String getClassName()

Specified by:

getClassName in interface CommandLine.Model.ITypeInfo

getClassSimpleName

public String getClassSimpleName()

Specified by:

getClassSimpleName in interface CommandLine.Model.ITypeInfo

getType

public 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 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

getActualGenericTypeArguments

public List<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

getAuxiliaryTypeInfos

public 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

getEnumConstantNames

public List<String> getEnumConstantNames()

Specified by:

getEnumConstantNames in interface CommandLine.Model.ITypeInfo

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object