Uses of Class
com.linecorp.armeria.server.docs.TypeSignature

Packages that use TypeSignature

Package	Description
com.linecorp.armeria.server.docs	Documentation service.

Uses of TypeSignature in com.linecorp.armeria.server.docs

Methods in com.linecorp.armeria.server.docs that return TypeSignature

Modifier and Type	Method and Description
static TypeSignature	TypeSignature.ofBase(String baseTypeName) Creates a new type signature for a base type.
static TypeSignature	TypeSignature.ofContainer(String containerTypeName, Iterable<TypeSignature> elementTypeSignatures) Creates a new container type with the specified container type name and the type signatures of the elements it contains.
static TypeSignature	TypeSignature.ofContainer(String containerTypeName, TypeSignature... elementTypeSignatures) Creates a new container type with the specified container type name and the type signatures of the elements it contains.
static TypeSignature	TypeSignature.ofList(Class<?> namedElementType) Creates a new type signature for the list with the specified named element type.
static TypeSignature	TypeSignature.ofList(TypeSignature elementTypeSignature) Creates a new type signature for the list with the specified element type signature.
static TypeSignature	TypeSignature.ofMap(Class<?> namedKeyType, Class<?> namedValueType) Creates a new type signature for the map with the specified named key and value types.
static TypeSignature	TypeSignature.ofMap(TypeSignature keyTypeSignature, TypeSignature valueTypeSignature) Creates a new type signature for the map with the specified key and value type signatures.
static TypeSignature	TypeSignature.ofNamed(Class<?> namedType) Creates a new named type signature for the specified type.
static TypeSignature	TypeSignature.ofNamed(String name, Object namedTypeDescriptor) Creates a new named type signature for the provided name and arbitrary descriptor.
static TypeSignature	TypeSignature.ofSet(Class<?> namedElementType) Creates a new type signature for the set with the specified named element type.
static TypeSignature	TypeSignature.ofSet(TypeSignature elementTypeSignature) Creates a new type signature for the set with the specified element type signature.
static TypeSignature	TypeSignature.ofUnresolved(String unresolvedTypeName) Creates a new unresolved type signature with the specified type name.
TypeSignature	MethodInfo.returnTypeSignature() Returns the signature of the return type of the function.
TypeSignature	FieldInfo.typeSignature() Returns the metadata about the type of the field.

Methods in com.linecorp.armeria.server.docs that return types with arguments of type TypeSignature

Modifier and Type	Method and Description
Set<TypeSignature>	MethodInfo.exceptionTypeSignatures() Returns the metadata about the exceptions declared by the function.
Set<TypeSignature>	StructInfo.findNamedTypes()
Set<TypeSignature>	ServiceInfo.findNamedTypes() Returns all enum, struct and exception TypeSignatures referred to by this service.
default Set<TypeSignature>	NamedTypeInfo.findNamedTypes() Returns all enum, struct and exception types referred by this type.
Set<TypeSignature>	ExceptionInfo.findNamedTypes()
List<TypeSignature>	TypeSignature.typeParameters() Returns the list of the type parameters of this type signature.

Methods in com.linecorp.armeria.server.docs with parameters of type TypeSignature

Modifier and Type	Method and Description
static FieldInfoBuilder	FieldInfo.builder(String name, TypeSignature typeSignature) Returns a newly created FieldInfoBuilder.
static FieldInfoBuilder	FieldInfo.builder(String name, TypeSignature typeSignature, FieldInfo... childFieldInfos) Returns a newly created FieldInfoBuilder.
static FieldInfoBuilder	FieldInfo.builder(String name, TypeSignature typeSignature, Iterable<FieldInfo> childFieldInfos) Returns a newly created FieldInfoBuilder.
static FieldInfo	FieldInfo.of(String name, TypeSignature typeSignature) Creates a new FieldInfo with the specified name and TypeSignature.
static TypeSignature	TypeSignature.ofContainer(String containerTypeName, TypeSignature... elementTypeSignatures) Creates a new container type with the specified container type name and the type signatures of the elements it contains.
static TypeSignature	TypeSignature.ofList(TypeSignature elementTypeSignature) Creates a new type signature for the list with the specified element type signature.
static TypeSignature	TypeSignature.ofMap(TypeSignature keyTypeSignature, TypeSignature valueTypeSignature) Creates a new type signature for the map with the specified key and value type signatures.
static TypeSignature	TypeSignature.ofSet(TypeSignature elementTypeSignature) Creates a new type signature for the set with the specified element type signature.

Method parameters in com.linecorp.armeria.server.docs with type arguments of type TypeSignature

Modifier and Type	Method and Description
static ServiceSpecification	ServiceSpecification.generate(Iterable<ServiceInfo> services, Function<TypeSignature,? extends NamedTypeInfo> namedTypeInfoFactory) Generates a new ServiceSpecification from the specified ServiceInfos and the factory Function that creates NamedTypeInfos for the enum, struct or exception types referred by the specified ServiceInfos.
static TypeSignature	TypeSignature.ofContainer(String containerTypeName, Iterable<TypeSignature> elementTypeSignatures) Creates a new container type with the specified container type name and the type signatures of the elements it contains.

Constructors in com.linecorp.armeria.server.docs with parameters of type TypeSignature

Constructor and Description
FieldInfoBuilder(String name, TypeSignature typeSignature) Deprecated. Use FieldInfo.builder(String, TypeSignature).
FieldInfoBuilder(String name, TypeSignature typeSignature, FieldInfo... childFieldInfos) Deprecated. Use FieldInfo.builder(String, TypeSignature, FieldInfo...).
FieldInfoBuilder(String name, TypeSignature typeSignature, Iterable<FieldInfo> childFieldInfos) Deprecated. Use FieldInfo.builder(String, TypeSignature, Iterable).
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints) Creates a new instance.
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, HttpMethod httpMethod, String docString) Creates a new instance.
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, Iterable<HttpHeaders> exampleHttpHeaders, Iterable<String> exampleRequests, HttpMethod httpMethod, String docString) Creates a new instance.

Constructor parameters in com.linecorp.armeria.server.docs with type arguments of type TypeSignature

Constructor and Description
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints) Creates a new instance.
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, HttpMethod httpMethod, String docString) Creates a new instance.
MethodInfo(String name, TypeSignature returnTypeSignature, Iterable<FieldInfo> parameters, Iterable<TypeSignature> exceptionTypeSignatures, Iterable<EndpointInfo> endpoints, Iterable<HttpHeaders> exampleHttpHeaders, Iterable<String> exampleRequests, HttpMethod httpMethod, String docString) Creates a new instance.