org.mule.metadata.api.annotation

Interface TypeAnnotation

All Known Implementing Classes:

AccessibilityAnnotation, DefaultValueAnnotation, DescriptionAnnotation, EnumAnnotation, EnumLabelsAnnotation, ExampleAnnotation, FieldOccurrenceAnnotation, IntAnnotation, LabelAnnotation, LengthAnnotation, MarkerAnnotation, MetadataFormatPropertiesAnnotation, NumberRangeAnnotation, RegexPatternAnnotation, TypeAliasAnnotation, TypeIdAnnotation, UniquesItemsAnnotation

public interface TypeAnnotation

An annotation associated to a given type that can add additional information or specify a constraint.

Method Summary

Modifier and Type	Method and Description
String	getName() A name of the annotation
default boolean	isPublic() Returns whether this annotation is public or not.

Method Detail

getName

String getName()

A name of the annotation

Returns:

The name

isPublic

default boolean isPublic()

Returns whether this annotation is public or not. Public annotations are those which carry information which should be consumed by third-parties, while non public ones are considered of exclusive use of the Mule runtime and thus should not be advertised. For example, non public annotations are not persisted.

Non public annotations will however always be available through MetadataType.getAnnotation(Class) and all related methods.

Returns:

Whether this annotation should be.