Class CompletionCandidatesMetaData
- java.lang.Object
-
- picocli.codegen.annotation.processing.CompletionCandidatesMetaData
-
- All Implemented Interfaces:
java.lang.Iterable<java.lang.String>
,ITypeMetaData
class CompletionCandidatesMetaData extends java.lang.Object implements java.lang.Iterable<java.lang.String>, ITypeMetaData
Implementation of theIterable
interface that provides metadata on the@Command(completionCandidates = 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 CompletionCandidatesMetaData(javax.lang.model.type.TypeMirror typeMirror)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.Iterable<java.lang.String>
extract(javax.lang.model.element.Element element)
Returns the completion candidates from the annotations present on the specified element.javax.lang.model.element.TypeElement
getTypeElement()
Returns theTypeElement
of thetype mirror
.javax.lang.model.type.TypeMirror
getTypeMirror()
Returns the TypeMirror that this TypeConverterMetaData was constructed with.boolean
isDefault()
Returnstrue
if the command did not have acompletionCandidates
annotation attribute.java.util.Iterator<java.lang.String>
iterator()
Always returnsnull
.java.lang.String
toString()
Returns a string representation of this object, for debugging purposes.
-
-
-
Method Detail
-
extract
public static java.lang.Iterable<java.lang.String> extract(javax.lang.model.element.Element element)
Returns the completion candidates from the annotations present on the specified element.- Parameters:
element
- the method or field annotated with@Option
or@Parameters
- Returns:
- the completion candidates or
null
if not found
-
isDefault
public boolean isDefault()
Returnstrue
if the command did not have acompletionCandidates
annotation attribute.- Specified by:
isDefault
in interfaceITypeMetaData
- Returns:
true
if the command did not have acompletionCandidates
annotation attribute.
-
getTypeMirror
public javax.lang.model.type.TypeMirror getTypeMirror()
Returns the TypeMirror that this TypeConverterMetaData was constructed with.- Specified by:
getTypeMirror
in interfaceITypeMetaData
- Returns:
- the TypeMirror of the
@Command(completionCandidates = xxx.class)
annotation.
-
getTypeElement
public javax.lang.model.element.TypeElement getTypeElement()
Description copied from interface:ITypeMetaData
Returns theTypeElement
of thetype mirror
.- Specified by:
getTypeElement
in interfaceITypeMetaData
- Returns:
- the type mirror as a TypeElement
-
iterator
public java.util.Iterator<java.lang.String> iterator()
Always returnsnull
.- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.String>
-
toString
public java.lang.String toString()
Returns a string representation of this object, for debugging purposes.- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of this object
-
-