Package com.linecorp.armeria.server.docs

Class StructInfo

java.lang.Object

com.linecorp.armeria.server.docs.StructInfo

All Implemented Interfaces:

DescriptiveTypeInfo

@UnstableApi
public final class StructInfo
extends Object
implements DescriptiveTypeInfo

Metadata about a struct type.

Constructor Summary

Constructors

Constructor	Description
StructInfo(String name, @Nullable String alias, Iterable<FieldInfo> fields, DescriptionInfo descriptionInfo)	Creates a new instance.
StructInfo(String name, Iterable<FieldInfo> fields)	Creates a new instance.
StructInfo(String name, Iterable<FieldInfo> fields, DescriptionInfo descriptionInfo)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@Nullable String	alias()	Returns the alias of the name().
DescriptionInfo	descriptionInfo()	Returns the description information of this struct.
boolean	equals(@Nullable Object o)
List<FieldInfo>	fields()	Returns the metadata about the fields of the type.
Set<DescriptiveTypeSignature>	findDescriptiveTypes()	Returns all enum, struct and exception types referred by this type.
int	hashCode()
String	name()	Returns the fully qualified type name.
String	toString()
StructInfo	withAlias(String alias)	Returns a new StructInfo with the specified alias.
StructInfo	withDescriptionInfo(DescriptionInfo descriptionInfo)	Returns a new StructInfo with the specified DescriptionInfo.
StructInfo	withFields(Iterable<FieldInfo> fields)	Returns a new StructInfo with the specified FieldInfos.

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,
 DescriptionInfo descriptionInfo)

Creates a new instance.

StructInfo

public StructInfo(String name,
 @Nullable
 @Nullable String alias,
 Iterable<FieldInfo> fields,
 DescriptionInfo descriptionInfo)

Creates a new instance.

Method Details

name

public String name()

Description copied from interface: DescriptiveTypeInfo

Returns the fully qualified type name.

Specified by:

name in interface DescriptiveTypeInfo

alias

@Nullable
public @Nullable String alias()

Returns the alias of the name(). An alias could be set when a StructInfo has two different names.

For example, if a StructInfo is extracted from a com.google.protobuf.Message, the name() is set to the full name defined in the proto file and the alias() is set to the name of the generated Class.

withAlias

public StructInfo withAlias(String alias)

Returns a new StructInfo with the specified alias. Returns this if this StructInfo has the same FieldInfos.

fields

public List<FieldInfo> fields()

Returns the metadata about the fields of the type.

withFields

public StructInfo withFields(Iterable<FieldInfo> fields)

Returns a new StructInfo with the specified FieldInfos. Returns this if this StructInfo has the same FieldInfos.

descriptionInfo

public DescriptionInfo descriptionInfo()

Returns the description information of this struct.

Specified by:

descriptionInfo in interface DescriptiveTypeInfo

withDescriptionInfo

public StructInfo withDescriptionInfo(DescriptionInfo descriptionInfo)

Returns a new StructInfo with the specified DescriptionInfo. Returns this if this StructInfo has the same DescriptionInfo.

findDescriptiveTypes

public Set<DescriptiveTypeSignature> findDescriptiveTypes()

Description copied from interface: DescriptiveTypeInfo

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

Specified by:

findDescriptiveTypes in interface DescriptiveTypeInfo

equals

public boolean equals(@Nullable
 @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