Package org.apache.qpid.protonj2.client

Interface ErrorCondition

All Known Implementing Classes:

ClientErrorCondition

public interface ErrorCondition

Conveys the error value used to inform the user of why an endpoint was closed or a delivery rejected.

Method Summary

Modifier and Type	Method	Description
String	condition()
static ErrorCondition	create(String condition, String description)	Create an error condition object using the supplied values.
static ErrorCondition	create(String condition, String description, Map<String,Object> info)	Create an error condition object using the supplied values.
String	description()	Descriptive text that supplies any supplementary details not indicated by the condition value..
Map<String,Object>	info()

Method Detail

condition

String condition()

Returns:

a value that indicates the type of error condition.

description

String description()

Descriptive text that supplies any supplementary details not indicated by the condition value..

Returns:

supplementary details not indicated by the condition value..

info

Map<String,Object> info()

Returns:

a Map carrying information about the error condition.

create

static ErrorCondition create(String condition,
                             String description)

Create an error condition object using the supplied values. The condition string cannot be null however the other attribute can.

Parameters:

condition - The value that defines the error condition.

description - The supplementary description for the given error condition.

Returns:

a new read-only ErrorCondition object

create

static ErrorCondition create(String condition,
                             String description,
                             Map<String,Object> info)

Create an error condition object using the supplied values. The condition string cannot be null however the other attribute can.

Parameters:

condition - The value that defines the error condition.

description - The supplementary description for the given error condition.

info - A Map containing additional error information.

Returns:

a new read-only ErrorCondition object