Package com.linecorp.armeria.server.docs
Class ExceptionInfo
java.lang.Object
com.linecorp.armeria.server.docs.ExceptionInfo
- All Implemented Interfaces:
NamedTypeInfo
Metadata about an exception type.
-
Constructor Summary
ConstructorsConstructorDescriptionExceptionInfo
(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 TypeMethodDescriptionReturns the description information.boolean
fields()
Returns the metadata about the fields of the type.Returns all enum, struct and exception types referred by this type.int
hashCode()
name()
Returns the fully qualified type name.toString()
withDescriptionInfo
(DescriptionInfo descriptionInfo) Returns a newExceptionInfo
with the specifiedDescriptionInfo
.withFields
(Iterable<FieldInfo> fields) Returns a newExceptionInfo
with the specifiedFieldInfo
s.
-
Constructor Details
-
ExceptionInfo
Creates a new instance. -
ExceptionInfo
Creates a new instance.
-
-
Method Details
-
name
Description copied from interface:NamedTypeInfo
Returns the fully qualified type name.- Specified by:
name
in interfaceNamedTypeInfo
-
fields
Returns the metadata about the fields of the type. -
withFields
Returns a newExceptionInfo
with the specifiedFieldInfo
s. Returnsthis
if thisExceptionInfo
has the sameFieldInfo
s. -
descriptionInfo
Description copied from interface:NamedTypeInfo
Returns the description information. If not available,DescriptionInfo.empty()
is returned.- Specified by:
descriptionInfo
in interfaceNamedTypeInfo
-
withDescriptionInfo
Returns a newExceptionInfo
with the specifiedDescriptionInfo
. Returnsthis
if thisExceptionInfo
has the sameDescriptionInfo
. -
findNamedTypes
Description copied from interface:NamedTypeInfo
Returns all enum, struct and exception types referred by this type.- Specified by:
findNamedTypes
in interfaceNamedTypeInfo
-
equals
-
hashCode
public int hashCode() -
toString
-