Package com.linecorp.armeria.server.docs

Class StructInfo

java.lang.Object

com.linecorp.armeria.server.docs.StructInfo

All Implemented Interfaces:

NamedTypeInfo

@UnstableApi
public final class StructInfo
extends Object
implements NamedTypeInfo

Metadata about a struct type.

Constructor Summary

Constructors

Constructor	Description
StructInfo(String name, Iterable<FieldInfo> fields)	Creates a new instance.
StructInfo(String name, Iterable<FieldInfo> fields, String docString)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	docString()	Returns the documentation string.
boolean	equals(Object o)
List<FieldInfo>	fields()	Returns the metadata about the fields of the type.
Set<TypeSignature>	findNamedTypes()	Returns all enum, struct and exception types referred by this type.
int	hashCode()
String	name()	Returns the fully qualified type name.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StructInfo

public StructInfo(String name,
Iterable<FieldInfo> fields)

Creates a new instance.

StructInfo

public StructInfo(String name,
Iterable<FieldInfo> fields,
@Nullable
String docString)

Creates a new instance.

Method Details

name

public String name()

Description copied from interface: NamedTypeInfo

Returns the fully qualified type name.

Specified by:

name in interface NamedTypeInfo

fields

public List<FieldInfo> fields()

Returns the metadata about the fields of the type.

docString

public String docString()

Description copied from interface: NamedTypeInfo

Returns the documentation string. If not available, an empty string is returned.

Specified by:

docString in interface NamedTypeInfo

findNamedTypes

public Set<TypeSignature> findNamedTypes()

Description copied from interface: NamedTypeInfo

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

Specified by:

findNamedTypes in interface NamedTypeInfo

equals

public boolean equals(@Nullable
Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object