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

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

    • Method Detail

      • condition

        java.lang.String condition()
        Returns:
        a value that indicates the type of error condition.

      • description

        java.lang.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

        java.util.Map<java.lang.String,​java.lang.Object> info()
        Returns:
        a Map carrying information about the error condition.

      • create

        static ErrorCondition create​(java.lang.String condition,
                             java.lang.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​(java.lang.String condition,
                             java.lang.String description,
                             java.util.Map<java.lang.String,​java.lang.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