Package io.micronaut.core.naming

Interface Described

All Known Subinterfaces:
AnnotationElement, ArrayableClassElement, BeanConstructor<T>, BeanConstructorElement, BeanDefinitionMethodReference<T,R>, BeanElement, BeanElementBuilder, BeanFieldElement, BeanMethodElement, BeanParameterElement, ClassElement, ConfigurableElement, ConfigurationClient, ConstructorElement, DelegatingExecutableMethod<T,R>, DiscoveryClient, Element, EnumConstantElement, EnumElement, ExecutableMethod<T,R>, FieldElement, GenericElement, GenericPlaceholderElement, InjectableElement, MemberElement, MethodElement, MethodInvocationContext<T,R>, PackageElement, ParameterElement, PropertyElement, TypedElement, WildcardElement
All Known Implementing Classes:
AbstractAnnotationElement, AbstractBeanConstructor, AbstractBeanDefinitionBeanConstructor, AbstractBeanDefinitionBuilder, AbstractExecutableBeanMethod, AbstractExecutableMethod, AbstractGroovyElement, AbstractJavaElement, BeanDefinitionWriter, CompositeDiscoveryClient, DefaultCompositeConfigurationClient, DefaultCompositeDiscoveryClient, GroovyClassElement, GroovyConstructorElement, GroovyEnumConstantElement, GroovyFieldElement, GroovyMethodElement, GroovyPackageElement, GroovyParameterElement, JavaClassElement, JavaMethodElement, JavaPackageElement, MessagingApplication, MethodInterceptorChain, PrimitiveElement
public interface Described
An interface for types that are described by a description.
Since:
1.0
Author:
graemerocher

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    getDescription()
    A description that describes this object.
    default @NonNull String
    getDescription(boolean simple)
    Allows returning a more simple description if requested.

  • Method Details

    • getDescription

      @NonNull @NonNull String getDescription()
      A description that describes this object.
      Returns:
      The description

    • getDescription

      @NonNull default @NonNull String getDescription(boolean simple)
      Allows returning a more simple description if requested.
      Parameters:
      simple - True if a simple description is required
      Returns:
      The simple description