Package com.linecorp.armeria.server.docs

Class FieldInfo

java.lang.Object

com.linecorp.armeria.server.docs.FieldInfo

@UnstableApi
public final class FieldInfo
extends Object

Metadata about a field of a struct or an exception.

See Also:

• FieldInfoBuilder

Method Summary

Modifier and Type	Method	Description
static FieldInfoBuilder	builder(String name, TypeSignature typeSignature)	Returns a newly created FieldInfoBuilder.
DescriptionInfo	descriptionInfo()	Returns the description information object of the field.
boolean	equals(@Nullable Object o)
int	hashCode()
FieldLocation	location()	Returns the location of the field.
String	name()	Returns the fully qualified type name of the field.
static FieldInfo	of(String name, TypeSignature typeSignature)	Creates a new FieldInfo with the specified name and TypeSignature.
static FieldInfo	of(String name, TypeSignature typeSignature, DescriptionInfo descriptionInfo)	Creates a new FieldInfo with the specified name, TypeSignature and description.
FieldRequirement	requirement()	Returns the requirement level of the field.
String	toString()
TypeSignature	typeSignature()	Returns the metadata about the type of the field.
FieldInfo	withDescriptionInfo(DescriptionInfo descriptionInfo)	Returns a new FieldInfo with the specified DescriptionInfo.

Methods inherited from class java.lang.Object

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

Method Details

of

public static FieldInfo of(String name,
 TypeSignature typeSignature)

Creates a new FieldInfo with the specified name and TypeSignature. The FieldLocation and FieldRequirement of the FieldInfo will be UNSPECIFIED.

of

public static FieldInfo of(String name,
 TypeSignature typeSignature,
 DescriptionInfo descriptionInfo)

Creates a new FieldInfo with the specified name, TypeSignature and description. The FieldLocation and FieldRequirement of the FieldInfo will be UNSPECIFIED.

builder

public static FieldInfoBuilder builder(String name,
 TypeSignature typeSignature)

Returns a newly created FieldInfoBuilder.

name

public String name()

Returns the fully qualified type name of the field.

location

public FieldLocation location()

Returns the location 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.

descriptionInfo

public DescriptionInfo descriptionInfo()

Returns the description information object of the field.

withDescriptionInfo

public FieldInfo withDescriptionInfo(DescriptionInfo descriptionInfo)

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

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