Package com.linecorp.armeria.server.docs

Class MethodInfo

java.lang.Object

com.linecorp.armeria.server.docs.MethodInfo

public final class MethodInfo
extends Object

Metadata about a function of a Service.

Constructor Summary

Constructors

Constructor	Description
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints)	Creates a new instance.
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, Iterable<HttpHeaders> exampleHttpHeaders, Iterable<String> exampleRequests, String docString)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	docString()	Returns the documentation string of the function.
Set<EndpointInfo>	endpoints()	Returns the endpoints for accessing this method.
boolean	equals(Object o)
List<HttpHeaders>	exampleHttpHeaders()	Returns the example HTTP headers of the method.
List<String>	exampleRequests()	Returns the list of the example request serialized in a string.
Set<TypeSignature>	exceptionTypeSignatures()	Returns the metadata about the exceptions declared by the function.
int	hashCode()
String	name()	Returns the name of the function.
List<FieldInfo>	parameters()	Returns the metadata about the parameters of the function.
TypeSignature	returnTypeSignature()	Returns the signature of the return type of the function.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodInfo

public MethodInfo(String name,
                  TypeSignature returnTypeSignature,
                  Iterable<FieldInfo> parameters,
                  Iterable<TypeSignature> exceptionTypeSignatures,
                  Iterable<EndpointInfo> endpoints)

Creates a new instance.

MethodInfo

public MethodInfo(String name,
                  TypeSignature returnTypeSignature,
                  Iterable<FieldInfo> parameters,
                  Iterable<TypeSignature> exceptionTypeSignatures,
                  Iterable<EndpointInfo> endpoints,
                  Iterable<HttpHeaders> exampleHttpHeaders,
                  Iterable<String> exampleRequests,
                  @Nullable
                  String docString)

Creates a new instance.

Method Detail

name

public String name()

Returns the name of the function.

returnTypeSignature

public TypeSignature returnTypeSignature()

Returns the signature of the return type of the function.

endpoints

public Set<EndpointInfo> endpoints()

Returns the endpoints for accessing this method.

parameters

public List<FieldInfo> parameters()

Returns the metadata about the parameters of the function.

exceptionTypeSignatures

public Set<TypeSignature> exceptionTypeSignatures()

Returns the metadata about the exceptions declared by the function.

exampleHttpHeaders

public List<HttpHeaders> exampleHttpHeaders()

Returns the example HTTP headers of the method.

exampleRequests

public List<String> exampleRequests()

Returns the list of the example request serialized in a string. The format of the example request string depends on the underlying RPC implementation.

docString

@Nullable
public String docString()

Returns the documentation string of the function.

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