com.linecorp.armeria.internal.server.annotation

Class AnnotatedDocServicePlugin

java.lang.Object

com.linecorp.armeria.internal.server.annotation.AnnotatedDocServicePlugin

All Implemented Interfaces:

DocServicePlugin

public final class AnnotatedDocServicePlugin
extends Object
implements DocServicePlugin

A DocServicePlugin implementation that supports the AnnotatedService.

Constructor Summary

Constructors

Constructor and Description
AnnotatedDocServicePlugin()

Method Summary

Modifier and Type	Method and Description
ServiceSpecification	generateSpecification(Set<ServiceConfig> serviceConfigs, DocServiceFilter filter) Generates a new ServiceSpecification that provides the information about the supported Services.
String	name() Returns the name of this plugin.
String	serializeExampleRequest(String serviceName, String methodName, Object exampleRequest) Serializes the specified example request into a string.
Set<Class<?>>	supportedExampleRequestTypes() Returns the Set of the example request types supported by this plugin.
Set<Class<? extends Service<?,?>>>	supportedServiceTypes() Returns the Set of the Service types supported by this plugin.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.docs.DocServicePlugin

guessServiceMethodName, guessServiceName, loadDocStrings

Constructor Detail

AnnotatedDocServicePlugin

public AnnotatedDocServicePlugin()

Method Detail

name

public String name()

Description copied from interface: DocServicePlugin

Returns the name of this plugin.

Specified by:

name in interface DocServicePlugin

supportedServiceTypes

public Set<Class<? extends Service<?,?>>> supportedServiceTypes()

Description copied from interface: DocServicePlugin

Returns the Set of the Service types supported by this plugin.

Specified by:

supportedServiceTypes in interface DocServicePlugin

generateSpecification

public ServiceSpecification generateSpecification(Set<ServiceConfig> serviceConfigs,
                                                  DocServiceFilter filter)

Description copied from interface: DocServicePlugin

Generates a new ServiceSpecification that provides the information about the supported Services.

Specified by:

generateSpecification in interface DocServicePlugin

Parameters:

serviceConfigs - the ServiceConfigs of the Services that are instances of the DocServicePlugin.supportedServiceTypes()

filter - the DocServiceFilter that checks whether a method will be included while building DocService

supportedExampleRequestTypes

public Set<Class<?>> supportedExampleRequestTypes()

Description copied from interface: DocServicePlugin

Returns the Set of the example request types supported by this plugin.

Specified by:

supportedExampleRequestTypes in interface DocServicePlugin

serializeExampleRequest

public String serializeExampleRequest(String serviceName,
                                      String methodName,
                                      Object exampleRequest)

Description copied from interface: DocServicePlugin

Serializes the specified example request into a string.

Specified by:

serializeExampleRequest in interface DocServicePlugin

Parameters:

serviceName - the name of the service

methodName - the name of the method

exampleRequest - the example request

Returns:

the serialized example, or null if not able to serialize.