Package com.linecorp.armeria.server.docs

Interface NamedTypeInfo

All Known Implementing Classes:

EnumInfo, ExceptionInfo, StructInfo

@UnstableApi
public interface NamedTypeInfo

Metadata about a named type.

Method Summary

Modifier and Type	Method	Description
DescriptionInfo	descriptionInfo()	Returns the description information.
default Set<TypeSignature>	findNamedTypes()	Returns all enum, struct and exception types referred by this type.
String	name()	Returns the fully qualified type name.

Method Details

name

String name()

Returns the fully qualified type name.

descriptionInfo

DescriptionInfo descriptionInfo()

Returns the description information. If not available, DescriptionInfo.empty() is returned.

findNamedTypes

default Set<TypeSignature> findNamedTypes()

Returns all enum, struct and exception types referred by this type.