Package com.linecorp.armeria.server.docs

Class ExceptionInfo

java.lang.Object

com.linecorp.armeria.server.docs.ExceptionInfo

All Implemented Interfaces:

DescriptiveTypeInfo

@UnstableApi
public final class ExceptionInfo
extends Object
implements DescriptiveTypeInfo

Metadata about an exception type.

Constructor Summary

Constructors

Constructor	Description
ExceptionInfo(String name, Iterable<FieldInfo> fields)	Creates a new instance.
ExceptionInfo(String name, Iterable<FieldInfo> fields, DescriptionInfo descriptionInfo)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
DescriptionInfo	descriptionInfo()	Returns the description information.
boolean	equals(@Nullable Object o)
List<FieldInfo>	fields()	Returns the metadata about the fields of the type.
Set<DescriptiveTypeSignature>	findDescriptiveTypes()	Returns all enum, struct and exception types referred by this type.
int	hashCode()
String	name()	Returns the fully qualified type name.
String	toString()
ExceptionInfo	withDescriptionInfo(DescriptionInfo descriptionInfo)	Returns a new ExceptionInfo with the specified DescriptionInfo.
ExceptionInfo	withFields(Iterable<FieldInfo> fields)	Returns a new ExceptionInfo with the specified FieldInfos.

Methods inherited from class java.lang.Object

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

Constructor Details

ExceptionInfo

public ExceptionInfo(String name,
 Iterable<FieldInfo> fields)

Creates a new instance.

ExceptionInfo

public ExceptionInfo(String name,
 Iterable<FieldInfo> fields,
 DescriptionInfo descriptionInfo)

Creates a new instance.

Method Details

name

public String name()

Description copied from interface: DescriptiveTypeInfo

Returns the fully qualified type name.

Specified by:

name in interface DescriptiveTypeInfo

fields

public List<FieldInfo> fields()

Returns the metadata about the fields of the type.

withFields

public ExceptionInfo withFields(Iterable<FieldInfo> fields)

Returns a new ExceptionInfo with the specified FieldInfos. Returns this if this ExceptionInfo has the same FieldInfos.

descriptionInfo

public DescriptionInfo descriptionInfo()

Description copied from interface: DescriptiveTypeInfo

Returns the description information. If not available, DescriptionInfo.empty() is returned.

Specified by:

descriptionInfo in interface DescriptiveTypeInfo

withDescriptionInfo

public ExceptionInfo withDescriptionInfo(DescriptionInfo descriptionInfo)

Returns a new ExceptionInfo with the specified DescriptionInfo. Returns this if this ExceptionInfo has the same DescriptionInfo.

findDescriptiveTypes

public Set<DescriptiveTypeSignature> findDescriptiveTypes()

Description copied from interface: DescriptiveTypeInfo

Returns all enum, struct and exception types referred by this type.

Specified by:

findDescriptiveTypes in interface DescriptiveTypeInfo

equals

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