Package com.linecorp.armeria.server.docs

Class ServiceSpecification

java.lang.Object

com.linecorp.armeria.server.docs.ServiceSpecification

@UnstableApi
public final class ServiceSpecification
extends Object

The specification of one or more Services that provides their ServiceInfos and DescriptiveTypeInfos.

Constructor Summary

Constructors

Constructor	Description
ServiceSpecification(Iterable<ServiceInfo> services, Iterable<EnumInfo> enums, Iterable<StructInfo> structs, Iterable<ExceptionInfo> exceptions)	Creates a new instance.
ServiceSpecification(Iterable<ServiceInfo> services, Iterable<EnumInfo> enums, Iterable<StructInfo> structs, Iterable<ExceptionInfo> exceptions, Iterable<HttpHeaders> exampleHeaders)	Creates a new instance.
ServiceSpecification(Iterable<ServiceInfo> services, Iterable<EnumInfo> enums, Iterable<StructInfo> structs, Iterable<ExceptionInfo> exceptions, Iterable<HttpHeaders> exampleHeaders, @Nullable Route docServiceRoute)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@Nullable Route	docServiceRoute()	Returns the path pattern string of the DocService mount location on server.
Set<EnumInfo>	enums()	Returns the metadata about the enums related with the services in this specification.
List<HttpHeaders>	exampleHeaders()	Returns the example HTTP headers of the services in this specification.
Set<ExceptionInfo>	exceptions()	Returns the metadata about the exceptions related with the services in this specification.
static ServiceSpecification	generate(Iterable<ServiceInfo> services, Function<DescriptiveTypeSignature,? extends DescriptiveTypeInfo> descriptiveTypeInfoFactory)	Generates a new ServiceSpecification from the specified ServiceInfos and the factory Function that creates DescriptiveTypeInfos for the enum, struct or exception types referred by the specified ServiceInfos.
static ServiceSpecification	merge(Iterable<ServiceSpecification> specs, Route docServiceRoute)	Merges the specified ServiceSpecifications into one.
Set<ServiceInfo>	services()	Returns the metadata about the services in this specification.
Set<StructInfo>	structs()	Returns the metadata about the structs related with the services in this specification.

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceSpecification

public ServiceSpecification(Iterable<ServiceInfo> services,
 Iterable<EnumInfo> enums,
 Iterable<StructInfo> structs,
 Iterable<ExceptionInfo> exceptions)

Creates a new instance.

ServiceSpecification

public ServiceSpecification(Iterable<ServiceInfo> services,
 Iterable<EnumInfo> enums,
 Iterable<StructInfo> structs,
 Iterable<ExceptionInfo> exceptions,
 Iterable<HttpHeaders> exampleHeaders)

Creates a new instance.

ServiceSpecification

public ServiceSpecification(Iterable<ServiceInfo> services,
 Iterable<EnumInfo> enums,
 Iterable<StructInfo> structs,
 Iterable<ExceptionInfo> exceptions,
 Iterable<HttpHeaders> exampleHeaders,
 @Nullable
 @Nullable Route docServiceRoute)

Creates a new instance.

Method Details

merge

public static ServiceSpecification merge(Iterable<ServiceSpecification> specs,
 Route docServiceRoute)

Merges the specified ServiceSpecifications into one.

generate

public static ServiceSpecification generate(Iterable<ServiceInfo> services,
 Function<DescriptiveTypeSignature,? extends DescriptiveTypeInfo> descriptiveTypeInfoFactory)

Generates a new ServiceSpecification from the specified ServiceInfos and the factory Function that creates DescriptiveTypeInfos for the enum, struct or exception types referred by the specified ServiceInfos.

services

public Set<ServiceInfo> services()

Returns the metadata about the services in this specification.

enums

public Set<EnumInfo> enums()

Returns the metadata about the enums related with the services in this specification.

structs

public Set<StructInfo> structs()

Returns the metadata about the structs related with the services in this specification.

exceptions

public Set<ExceptionInfo> exceptions()

Returns the metadata about the exceptions related with the services in this specification.

exampleHeaders

public List<HttpHeaders> exampleHeaders()

Returns the example HTTP headers of the services in this specification.

docServiceRoute

@Nullable
public @Nullable Route docServiceRoute()

Returns the path pattern string of the DocService mount location on server.