Package com.linecorp.armeria.server.docs

Class ServiceInfo

java.lang.Object

com.linecorp.armeria.server.docs.ServiceInfo

@UnstableApi
public final class ServiceInfo
extends Object

Metadata about a Service.

Constructor Summary

Constructors

Constructor	Description
ServiceInfo(String name, Iterable<MethodInfo> methods)	Creates a new instance.
ServiceInfo(String name, Iterable<MethodInfo> methods, Iterable<HttpHeaders> exampleHeaders, String docString)	Creates a new instance.
ServiceInfo(String name, Iterable<MethodInfo> methods, String docString)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	docString()	Returns the documentation string.
boolean	equals(Object o)
List<HttpHeaders>	exampleHeaders()	Returns the example HTTP headers of the service.
Set<TypeSignature>	findNamedTypes()	Returns all enum, struct and exception TypeSignatures referred to by this service.
int	hashCode()
Set<MethodInfo>	methods()	Returns the metadata about the methods available in the service.
String	name()	Returns the fully qualified type name of the service.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceInfo

public ServiceInfo(String name,
Iterable<MethodInfo> methods)

Creates a new instance.

ServiceInfo

public ServiceInfo(String name,
Iterable<MethodInfo> methods,
@Nullable
String docString)

Creates a new instance.

ServiceInfo

public ServiceInfo(String name,
Iterable<MethodInfo> methods,
Iterable<HttpHeaders> exampleHeaders,
@Nullable
String docString)

Creates a new instance.

Method Details

name

public String name()

Returns the fully qualified type name of the service.

methods

public Set<MethodInfo> methods()

Returns the metadata about the methods available in the service.

findNamedTypes

public Set<TypeSignature> findNamedTypes()

Returns all enum, struct and exception TypeSignatures referred to by this service.

docString

@Nullable
public String docString()

Returns the documentation string.

exampleHeaders

public List<HttpHeaders> exampleHeaders()

Returns the example HTTP headers of the service.

equals

public boolean equals(@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