Package com.linecorp.armeria.server.docs

Class MethodInfo

java.lang.Object

com.linecorp.armeria.server.docs.MethodInfo

@UnstableApi
public final class MethodInfo
extends Object

Metadata about a function of a Service.

Constructor Summary

Constructors

Constructor	Description
MethodInfo(String serviceName, String name, int overloadId, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<EndpointInfo> endpoints, Iterable<String> examplePaths, Iterable<String> exampleQueries, HttpMethod httpMethod, DescriptionInfo descriptionInfo)	Creates a new instance.
MethodInfo(String serviceName, String name, int overloadId, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, HttpMethod httpMethod, DescriptionInfo descriptionInfo)	Creates a new instance.
MethodInfo(String serviceName, String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, boolean useParameterAsRoot, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, Iterable<HttpHeaders> exampleHeaders, Iterable<String> exampleRequests, Iterable<String> examplePaths, Iterable<String> exampleQueries, HttpMethod httpMethod, DescriptionInfo descriptionInfo)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
DescriptionInfo	descriptionInfo()	Returns the description information of the function.
Set<EndpointInfo>	endpoints()	Returns the endpoints for accessing this method.
boolean	equals(@Nullable Object o)
List<HttpHeaders>	exampleHeaders()	Returns the example HTTP headers of the method.
List<String>	examplePaths()	Returns the example paths of the method.
List<String>	exampleQueries()	Returns the example queries 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()
HttpMethod	httpMethod()	Returns the HTTP method of this method.
String	id()	Returns the id of this function.
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()
boolean	useParameterAsRoot()	Tells whether the parameters() is used as the root when creating JSON schema.
MethodInfo	withDescriptionInfo(DescriptionInfo descriptionInfo)	Returns a new MethodInfo with the specified DescriptionInfo.
MethodInfo	withParameters(Iterable<FieldInfo> parameters)	Returns a new MethodInfo with the specified parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

MethodInfo

public MethodInfo(String serviceName,
 String name,
 int overloadId,
 TypeSignature returnTypeSignature,
 Iterable<FieldInfo> parameters,
 Iterable<TypeSignature> exceptionTypeSignatures,
 Iterable<EndpointInfo> endpoints,
 HttpMethod httpMethod,
 DescriptionInfo descriptionInfo)

Creates a new instance.

MethodInfo

public MethodInfo(String serviceName,
 String name,
 int overloadId,
 TypeSignature returnTypeSignature,
 Iterable<FieldInfo> parameters,
 Iterable<EndpointInfo> endpoints,
 Iterable<String> examplePaths,
 Iterable<String> exampleQueries,
 HttpMethod httpMethod,
 DescriptionInfo descriptionInfo)

Creates a new instance.

MethodInfo

public MethodInfo(String serviceName,
 String name,
 TypeSignature returnTypeSignature,
 Iterable<FieldInfo> parameters,
 boolean useParameterAsRoot,
 Iterable<TypeSignature> exceptionTypeSignatures,
 Iterable<EndpointInfo> endpoints,
 Iterable<HttpHeaders> exampleHeaders,
 Iterable<String> exampleRequests,
 Iterable<String> examplePaths,
 Iterable<String> exampleQueries,
 HttpMethod httpMethod,
 DescriptionInfo descriptionInfo)

Creates a new instance.

Method Details

id

public String id()

Returns the id of this function. It's a form of serviceName/methodName/httpMethod. The methodName might have -x suffix if the method is overloaded.

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.

useParameterAsRoot

public boolean useParameterAsRoot()

Tells whether the parameters() is used as the root when creating JSON schema. The size of the parameters() must be one if this returns true.

withParameters

public MethodInfo withParameters(Iterable<FieldInfo> parameters)

Returns a new MethodInfo with the specified parameters. Returns this if this MethodInfo has the same parameters.

exceptionTypeSignatures

public Set<TypeSignature> exceptionTypeSignatures()

Returns the metadata about the exceptions declared by the function.

exampleHeaders

public List<HttpHeaders> exampleHeaders()

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.

examplePaths

public List<String> examplePaths()

Returns the example paths of the method.

exampleQueries

public List<String> exampleQueries()

Returns the example queries of the method.

httpMethod

public HttpMethod httpMethod()

Returns the HTTP method of this method.

descriptionInfo

public DescriptionInfo descriptionInfo()

Returns the description information of the function.

withDescriptionInfo

public MethodInfo withDescriptionInfo(DescriptionInfo descriptionInfo)

Returns a new MethodInfo with the specified DescriptionInfo. Returns this if this MethodInfo 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