Package com.linecorp.armeria.server.docs

Interface NamedTypeInfoProvider

All Known Implementing Classes:

ProtobufNamedTypeInfoProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@UnstableApi
@FunctionalInterface
public interface NamedTypeInfoProvider

Creates a new NamedTypeInfo loaded dynamically via Java SPI (Service Provider Interface). The loaded NamedTypeInfoProviders are used in the DocServicePlugins to extract a NamedTypeInfo from the given typeDescriptor.

Method Summary

Modifier and Type	Method	Description
@Nullable NamedTypeInfo	newNamedTypeInfo(Object typeDescriptor)	Creates a new NamedTypeInfo for the specified typeDescriptor.
default NamedTypeInfoProvider	orElse(NamedTypeInfoProvider other)	Returns a newly created NamedTypeInfoProvider that tries this NamedTypeInfoProvider first and then the specified NamedTypeInfoProvider when the first call returns null.

Method Details

newNamedTypeInfo

@Nullable
@Nullable NamedTypeInfo newNamedTypeInfo(Object typeDescriptor)

Creates a new NamedTypeInfo for the specified typeDescriptor. If a null value is returned, a DocServicePlugin will try to convert the typeDescriptor by the next converter.

The type descriptor is different depending on the implementation of DocServicePlugin. One of the following type descriptions may be chosen to describe a type information.

• Class for AnnotatedDocServicePlugin
• com.google.protobuf.Descriptors.Descriptor and com.google.protobuf.Descriptors.EnumDescriptor for GrpcDocServicePlugin
• org.apache.thrift.TBase org.apache.thrift.TEnum and org.apache.thrift.TException for ThriftDocServicePlugin

Returns:

a new NamedTypeInfo. null if this NamedTypeInfoProvider cannot convert the typeDescriptor to the NamedTypeInfo.

orElse

default NamedTypeInfoProvider orElse(NamedTypeInfoProvider other)

Returns a newly created NamedTypeInfoProvider that tries this NamedTypeInfoProvider first and then the specified NamedTypeInfoProvider when the first call returns null.