Package com.linecorp.armeria.server.docs

Class DescriptiveTypeSignature

java.lang.Object

com.linecorp.armeria.server.docs.DescriptiveTypeSignature

All Implemented Interfaces:

TypeSignature

@UnstableApi
public class DescriptiveTypeSignature
extends Object

A descriptive TypeSignature.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DescriptiveTypeSignature(TypeSignatureType type, String name, Object descriptor)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
Object	descriptor()	Returns the descriptor of the type if and only if this type signature represents a descriptive type.
boolean	equals(@Nullable Object o)
int	hashCode()
String	name()	Returns the name of the type.
String	toString()
TypeSignatureType	type()	Returns the TypeSignatureType.

Methods inherited from class java.lang.Object

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

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

signature

Constructor Details

DescriptiveTypeSignature

protected DescriptiveTypeSignature(TypeSignatureType type,
 String name,
 Object descriptor)

Create a new instance.

Method Details

descriptor

public Object descriptor()

Returns the descriptor of the type if and only if this type signature represents a descriptive type. For reflection-based DocServicePlugins, this will probably be a Class, but other plugins may use an actual instance with descriptor information.

equals

public boolean equals(@Nullable
 @Nullable Object o)

hashCode

public int hashCode()

type

public TypeSignatureType type()

Description copied from interface: TypeSignature

Returns the TypeSignatureType.

Specified by:

type in interface TypeSignature

name

public String name()

Description copied from interface: TypeSignature

Returns the name of the type.

Specified by:

name in interface TypeSignature

toString

public String toString()

Overrides:

toString in class Object