Package com.linecorp.armeria.server.protobuf

Class ProtobufDescriptiveTypeInfoProvider

java.lang.Object

com.linecorp.armeria.server.protobuf.ProtobufDescriptiveTypeInfoProvider

All Implemented Interfaces:

DescriptiveTypeInfoProvider

@UnstableApi
public final class ProtobufDescriptiveTypeInfoProvider
extends Object
implements DescriptiveTypeInfoProvider

A DescriptiveTypeInfoProvider to create a DescriptiveTypeInfo from a protobuf Message.

Constructor Summary

Constructors

Constructor	Description
ProtobufDescriptiveTypeInfoProvider()

Method Summary

Modifier and Type	Method	Description
@Nullable DescriptiveTypeInfo	newDescriptiveTypeInfo(Object typeDescriptor)	Creates a new DescriptiveTypeInfo for the specified typeDescriptor.
static StructInfo	newStructInfo(Descriptors.Descriptor descriptor)	Creates a new StructInfo from the specified Descriptors.Descriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.server.docs.DescriptiveTypeInfoProvider

orElse

Constructor Details

ProtobufDescriptiveTypeInfoProvider

public ProtobufDescriptiveTypeInfoProvider()

Method Details

newDescriptiveTypeInfo

@Nullable
public @Nullable DescriptiveTypeInfo newDescriptiveTypeInfo(Object typeDescriptor)

Description copied from interface: DescriptiveTypeInfoProvider

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

Specified by:

newDescriptiveTypeInfo in interface DescriptiveTypeInfoProvider

Returns:

a new DescriptiveTypeInfo. null if this DescriptiveTypeInfoProvider cannot convert the typeDescriptor to the DescriptiveTypeInfo.

newStructInfo

@UnstableApi
public static StructInfo newStructInfo(Descriptors.Descriptor descriptor)

Creates a new StructInfo from the specified Descriptors.Descriptor.