Package io.micronaut.core.naming

Interface Described

All Known Subinterfaces:
BeanConstructor<T>
All Known Implementing Classes:
AbstractBeanConstructor
public interface Described
An interface for types that are described by a description.
Since:
1.0

  • 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