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 createdFieldInfoBuilder
.static FieldInfoBuilder
builder(String name, TypeSignature typeSignature, FieldInfo... childFieldInfos)
Returns a newly createdFieldInfoBuilder
.static FieldInfoBuilder
builder(String name, TypeSignature typeSignature, Iterable<FieldInfo> childFieldInfos)
Returns a newly createdFieldInfoBuilder
.List<FieldInfo>
childFieldInfos()
Returns the child field infos of the field.String
docString()
Returns the documentation string of the field.boolean
equals(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)
FieldRequirement
requirement()
Returns the requirement level of the field.String
toString()
TypeSignature
typeSignature()
Returns the metadata about the type of the field.
-
Method Details
-
of
Creates a newFieldInfo
with the specifiedname
andTypeSignature
. TheFieldLocation
andFieldRequirement
of theFieldInfo
will beUNSPECIFIED
. -
builder
Returns a newly createdFieldInfoBuilder
. -
builder
public static FieldInfoBuilder builder(String name, TypeSignature typeSignature, FieldInfo... childFieldInfos)Returns a newly createdFieldInfoBuilder
. -
builder
public static FieldInfoBuilder builder(String name, TypeSignature typeSignature, Iterable<FieldInfo> childFieldInfos)Returns a newly createdFieldInfoBuilder
. -
name
Returns the fully qualified type name of the field. -
location
Returns the location of the field. -
requirement
Returns the requirement level of the field. -
typeSignature
Returns the metadata about the type of the field. -
childFieldInfos
Returns the child field infos of the field. -
docString
Returns the documentation string of the field. -
equals
-
hashCode
public int hashCode() -
toString
-