The annotation contains fields that specify various aspects of a scripting type information.
The NestFieldInformation annotation can be used in conjunction with this in order to specify the field informations of the type.
The NestInformation can be used to provide documentational information about the type.
Some informations like kind is determined by the referencing NestTypeUsage annotation.
public NestTypeUsage[] | Specifies the element types of the annotated type. |
public NestFieldInformation[] | Specifies the enumeration values of the type. |
public String | Specifies the kind of the type. |
public String | Specifies the qualified name of the type that should be use when presented to the scripting runtime. |
public NestTypeUsage[] | Specifies the types which are related to the annotated type. |
From: Annotation |
This is useful if the annotated type should be treated in a way similar to collections.
The element types specified in NestTypeUsage.elementTypes() will override this value if set.
This field can be used to specify the enumeration values in the annotated type.
If the annotated type is an enum
, the it is recommended to place these annotations directly on the
enumeration constants instead. Any annotation placed on the enumeration constant will overwrite the values in
this field.
This field is useful when the annotated type is not actually an enum
, but should be treated in an
enumeration way for scripting purposes.
The NestFieldInformation.type() field in the specified field information annotations is ignored, and set to the annotated type information.
The kind will be overriden by NestTypeUsage.kind() if set.
By default it will be determined based on the annotated type.
By default the canonical name of the annotated class is used.
If the specified qualified name starts with a dot (.
), then the canonical name of the enclosing
element of the annotated type will be prepended to it. (See
ReflectUtils.getEnclosingCanonicalNameOf(
The simple name of the type is determined by taking the name
component after the last dot (.
) character in the qualified name.