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
    String docString()
    Returns the documentation string.
    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.

    • docString

      @Nullable String docString()
      Returns the documentation string. If not available, an empty string is returned.

    • findNamedTypes

      default Set<TypeSignature> findNamedTypes()
      Returns all enum, struct and exception types referred by this type.