Package com.linecorp.armeria.server.docs
Class ServiceInfo
java.lang.Object
com.linecorp.armeria.server.docs.ServiceInfo
Metadata about a
Service
.-
Constructor Summary
ConstructorDescriptionServiceInfo
(String name, Iterable<MethodInfo> methods) Creates a new instance.ServiceInfo
(String name, Iterable<MethodInfo> methods, DescriptionInfo descriptionInfo) Creates a new instance.ServiceInfo
(String name, Iterable<MethodInfo> methods, Iterable<HttpHeaders> exampleHeaders, DescriptionInfo descriptionInfo) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the description information of the service.boolean
Returns the example HTTP headers of the service.Returns all enum, struct and exceptionTypeSignature
s referred to by this service.findDescriptiveTypes
(boolean request) int
hashCode()
methods()
Returns the metadata about the methods available in the service.name()
Returns the fully qualified type name of the service.toString()
withDescriptionInfo
(DescriptionInfo descriptionInfo) Returns a newServiceInfo
with the specifiedDescriptionInfo
.withExampleHeaders
(Iterable<HttpHeaders> exampleHeaders) Returns a newServiceInfo
with the specified example headers.withMethods
(Iterable<MethodInfo> methods) Returns a newServiceInfo
with the specifiedMethodInfo
s.
-
Constructor Details
-
ServiceInfo
Creates a new instance. -
ServiceInfo
Creates a new instance. -
ServiceInfo
public ServiceInfo(String name, Iterable<MethodInfo> methods, Iterable<HttpHeaders> exampleHeaders, DescriptionInfo descriptionInfo) Creates a new instance.
-
-
Method Details
-
name
Returns the fully qualified type name of the service. -
methods
Returns the metadata about the methods available in the service. -
withMethods
Returns a newServiceInfo
with the specifiedMethodInfo
s. Returnsthis
if thisServiceInfo
has the sameMethodInfo
s. -
findDescriptiveTypes
Returns all enum, struct and exceptionTypeSignature
s referred to by this service. -
findDescriptiveTypes
Returns allTypeSignature
ofMethodInfo.parameters()
ofmethods()
ifrequest
is set to true. Otherwise, returns allMethodInfo.returnTypeSignature()
andMethodInfo.exceptionTypeSignatures()
of themethods()
. -
descriptionInfo
Returns the description information of the service. If not available,DescriptionInfo.empty()
is returned. -
withDescriptionInfo
Returns a newServiceInfo
with the specifiedDescriptionInfo
. Returnsthis
if thisServiceInfo
has the sameDescriptionInfo
. -
exampleHeaders
Returns the example HTTP headers of the service. -
withExampleHeaders
Returns a newServiceInfo
with the specified example headers. Returnsthis
if thisServiceInfo
has the same example headers. -
equals
-
hashCode
public int hashCode() -
toString
-