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, ConstructorInjectionPoint<T>, DelegatingExecutableMethod<T,R>, DiscoveryClient, Element, EnumElement, ExecutableMethod<T,R>, FieldElement, GenericPlaceholderElement, InjectableElement, MemberElement, MethodElement, MethodInvocationContext<T,R>, PackageElement, ParameterElement, PropertyElement, TypedElement, WildcardElement

All Known Implementing Classes:

AbstractBeanConstructor, AbstractBeanDefinitionBuilder, AbstractConstructorInjectionPoint, AbstractExecutableBeanMethod, AbstractExecutableMethod, AbstractGroovyElement, AbstractJavaElement, BeanDefinitionWriter, CompositeDiscoveryClient, DefaultCompositeConfigurationClient, DefaultCompositeDiscoveryClient, GroovyClassElement, GroovyConstructorElement, 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 and Description
java.lang.String	getDescription() A description that describes this object.
default java.lang.String	getDescription(boolean simple) Allows returning a more simple description if requested.

Method Detail

getDescription

@NonNull
java.lang.String getDescription()

A description that describes this object.

Returns:

The description

getDescription

@NonNull
default java.lang.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