com.linecorp.armeria.server.docs

Class FieldInfoBuilder

java.lang.Object

com.linecorp.armeria.server.docs.FieldInfoBuilder

@UnstableApi
public final class FieldInfoBuilder
extends Object

Creates a new FieldInfo using the builder pattern.

Constructor Summary

Constructors

Constructor and Description
FieldInfoBuilder(String name, TypeSignature typeSignature) Deprecated. Use FieldInfo.builder(String, TypeSignature).
FieldInfoBuilder(String name, TypeSignature typeSignature, FieldInfo... childFieldInfos) Deprecated. Use FieldInfo.builder(String, TypeSignature, FieldInfo...).
FieldInfoBuilder(String name, TypeSignature typeSignature, Iterable<FieldInfo> childFieldInfos) Deprecated. Use FieldInfo.builder(String, TypeSignature, Iterable).

Method Summary

Modifier and Type	Method and Description
FieldInfo	build() Returns a newly-created FieldInfo based on the properties of this builder.
FieldInfoBuilder	docString(String docString) Sets the documentation string of the field.
FieldInfoBuilder	location(FieldLocation location) Sets the FieldLocation of the field.
FieldInfoBuilder	requirement(FieldRequirement requirement) Sets the FieldRequirement of the field.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldInfoBuilder

@Deprecated
public FieldInfoBuilder(String name,
                                    TypeSignature typeSignature)

Deprecated. Use FieldInfo.builder(String, TypeSignature).

Creates a new FieldInfoBuilder.

FieldInfoBuilder

@Deprecated
public FieldInfoBuilder(String name,
                                    TypeSignature typeSignature,
                                    FieldInfo... childFieldInfos)

Deprecated. Use FieldInfo.builder(String, TypeSignature, FieldInfo...).

Creates a new FieldInfoBuilder.

FieldInfoBuilder

@Deprecated
public FieldInfoBuilder(String name,
                                    TypeSignature typeSignature,
                                    Iterable<FieldInfo> childFieldInfos)

Deprecated. Use FieldInfo.builder(String, TypeSignature, Iterable).

Creates a new FieldInfoBuilder.

Method Detail

requirement

public FieldInfoBuilder requirement(FieldRequirement requirement)

Sets the FieldRequirement of the field.

location

public FieldInfoBuilder location(FieldLocation location)

Sets the FieldLocation of the field.

docString

public FieldInfoBuilder docString(String docString)

Sets the documentation string of the field.

build

public FieldInfo build()

Returns a newly-created FieldInfo based on the properties of this builder.

toString

public String toString()

Overrides:

toString in class Object