Package com.linecorp.armeria.server.docs

Interface DescriptiveTypeInfoProvider

All Known Implementing Classes:

ProtobufDescriptiveTypeInfoProvider

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 DescriptiveTypeInfoProvider

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

Method Summary

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

Method Details

newDescriptiveTypeInfo

@Nullable
@Nullable DescriptiveTypeInfo newDescriptiveTypeInfo(Object typeDescriptor)

Creates a new DescriptiveTypeInfo 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 DescriptiveTypeInfo. null if this DescriptiveTypeInfoProvider cannot convert the typeDescriptor to the DescriptiveTypeInfo.

orElse

default DescriptiveTypeInfoProvider orElse(DescriptiveTypeInfoProvider other)

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