com.linecorp.armeria.server.docs

Class FieldInfo

java.lang.Object

com.linecorp.armeria.server.docs.FieldInfo

public final class FieldInfo
extends Object

Metadata about a field of a struct or an exception.

Constructor Summary

Constructors

Constructor and Description
FieldInfo(String name, FieldRequirement requirement, TypeSignature typeSignature) Creates a new instance.
FieldInfo(String name, FieldRequirement requirement, TypeSignature typeSignature, String docString) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
String	docString() Returns the documentation string of the field.
boolean	equals(Object o)
int	hashCode()
String	name() Returns the fully qualified type name of the field.
FieldRequirement	requirement() Returns the requirement level of the field.
String	toString()
TypeSignature	typeSignature() Returns the metadata about the type of the field.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldInfo

public FieldInfo(String name,
                 FieldRequirement requirement,
                 TypeSignature typeSignature)

Creates a new instance.

FieldInfo

public FieldInfo(String name,
                 FieldRequirement requirement,
                 TypeSignature typeSignature,
                 @Nullable
                 String docString)

Creates a new instance.

Method Detail

name

public String name()

Returns the fully qualified type name of the field.

requirement

public FieldRequirement requirement()

Returns the requirement level of the field.

typeSignature

public TypeSignature typeSignature()

Returns the metadata about the type of the field.

docString

@Nullable
public String docString()

Returns the documentation string of the field.

equals

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