Package com.linecorp.armeria.server.docs
Class MethodInfo
java.lang.Object
com.linecorp.armeria.server.docs.MethodInfo
Metadata about a function of a
Service
.-
Constructor Summary
ConstructorDescriptionMethodInfo
(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, HttpMethod httpMethod, @Nullable String docString) Creates a new instance.MethodInfo
(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, Iterable<HttpHeaders> exampleHeaders, Iterable<String> exampleRequests, Iterable<String> examplePaths, Iterable<String> exampleQueries, HttpMethod httpMethod, @Nullable String docString) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the documentation string of the function.Returns the endpoints for accessing this method.boolean
Returns the example HTTP headers of the method.Returns the example paths of the method.Returns the example queries of the method.Returns the list of the example request serialized in a string.Returns the metadata about the exceptions declared by the function.int
hashCode()
Returns the HTTP method of this method.name()
Returns the name of the function.Returns the metadata about the parameters of the function.Returns the signature of the return type of the function.toString()
-
Constructor Details
-
MethodInfo
public MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, HttpMethod httpMethod, @Nullable @Nullable String docString) Creates a new instance. -
MethodInfo
public MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, Iterable<HttpHeaders> exampleHeaders, Iterable<String> exampleRequests, Iterable<String> examplePaths, Iterable<String> exampleQueries, HttpMethod httpMethod, @Nullable @Nullable String docString) Creates a new instance.
-
-
Method Details
-
name
Returns the name of the function. -
returnTypeSignature
Returns the signature of the return type of the function. -
endpoints
Returns the endpoints for accessing this method. -
parameters
Returns the metadata about the parameters of the function. -
exceptionTypeSignatures
Returns the metadata about the exceptions declared by the function. -
exampleHeaders
Returns the example HTTP headers of the method. -
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
Returns the example paths of the method. -
exampleQueries
Returns the example queries of the method. -
httpMethod
Returns the HTTP method of this method. -
docString
Returns the documentation string of the function. -
equals
-
hashCode
public int hashCode() -
toString
-