Class ReflectionIntrospectionConfiguration.Description

java.lang.Object
io.micronaut.reflection.ReflectionIntrospectionConfiguration.Description
Enclosing class:
ReflectionIntrospectionConfiguration
@Internal @EachProperty(value="reflective", list=true) public static final class ReflectionIntrospectionConfiguration.Description extends Object
The types matching a set of patterns, and the Introspected members the shared introspector describes them with.

A member left unset is left to its default, which is what the reflective description already applies, and a type carrying Introspected of its own keeps what it declares: a pattern names types in bulk, and does not displace what one of them says of itself.

Introspected.includedAnnotations() is not among the members: the processor uses it to choose the classes to scan for the packages Introspected.packages() names, not to filter the properties its javadoc describes, so configuring it would change nothing.

Since:
5.2.0
Author:
Denis Stepanov

  • Constructor Details

    • Description

      public Description()
      Creates the description; it is instantiated by the context.

  • Method Details

    • getTypes

      public List<String> getTypes()
      The patterns of the types this describes.
      Returns:
      The patterns of the types this describes

    • setTypes

      public void setTypes(@Nullable List<String> types)
      The patterns of the types this describes, a pattern being a class name where * stands for any sequence of characters. The types matching them are allowed to be described reflectively, as ReflectionIntrospectionConfiguration.setAllowReflection(List) allows them.
      Parameters:
      types - The patterns

    • getAccessKind

      public List<Introspected.AccessKind> getAccessKind()
      What makes a property.
      Returns:
      The access kinds

    • setAccessKind

      public void setAccessKind(@Nullable List<Introspected.AccessKind> accessKind)
      What makes a property, in the order it is preferred where a type has both.
      Parameters:
      accessKind - The access kinds, Introspected.AccessKind.METHOD by default
      See Also:

    • getVisibility

      public List<Introspected.Visibility> getVisibility()
      How visible a member has to be to make a property.
      Returns:
      The visibilities

    • setVisibility

      public void setVisibility(@Nullable List<Introspected.Visibility> visibility)
      How visible a member has to be to make a property.
      Parameters:
      visibility - The visibilities, Introspected.Visibility.DEFAULT by default
      See Also:

    • getIncludes

      public List<String> getIncludes()
      The names of the only properties to describe.
      Returns:
      The property names to describe

    • setIncludes

      public void setIncludes(@Nullable List<String> includes)
      The names of the only properties to describe, all of them by default.
      Parameters:
      includes - The property names
      See Also:

    • getExcludes

      public List<String> getExcludes()
      The names of the properties to leave out.
      Returns:
      The property names to leave out

    • setExcludes

      public void setExcludes(@Nullable List<String> excludes)
      The names of the properties to leave out, none by default.
      Parameters:
      excludes - The property names
      See Also:

    • getExcludedAnnotations

      public List<String> getExcludedAnnotations()
      The annotations that leave a property out.
      Returns:
      The annotations that leave a property out

    • setExcludedAnnotations

      public void setExcludedAnnotations(@Nullable List<String> excludedAnnotations)
      The names of the annotations that leave a property out, none by default.
      Parameters:
      excludedAnnotations - The annotation names
      See Also:

    • getAnnotationMetadata

      public @Nullable Boolean getAnnotationMetadata()
      Whether the properties carry their annotations.
      Returns:
      Whether the properties carry their annotations, null when it is not configured

    • setAnnotationMetadata

      public void setAnnotationMetadata(@Nullable Boolean annotationMetadata)
      Whether the properties carry the annotations of their members, which they do by default.
      Parameters:
      annotationMetadata - Whether the properties carry their annotations
      See Also:

    • getIndexed

      public List<ReflectionIntrospectionConfiguration.Description.Indexed> getIndexed()
      The annotations to index the properties by.
      Returns:
      The annotations to index the properties by

    • setIndexed

      public void setIndexed(@Nullable List<ReflectionIntrospectionConfiguration.Description.Indexed> indexed)
      The annotations to index the properties by, so that BeanIntrospection.getIndexedProperties(Class) finds them; none by default.
      Parameters:
      indexed - The annotations
      See Also: