Interface StompHeaders

  • All Superinterfaces:
    Headers<java.lang.CharSequence,​java.lang.CharSequence,​StompHeaders>, java.lang.Iterable<java.util.Map.Entry<java.lang.CharSequence,​java.lang.CharSequence>>
    All Known Implementing Classes:
    DefaultStompHeaders

    public interface StompHeaders
    extends Headers<java.lang.CharSequence,​java.lang.CharSequence,​StompHeaders>
    The multimap data structure for the STOMP header names and values. It also provides the constants for the standard STOMP header names and values.
    • Method Detail

      • getAsString

        java.lang.String getAsString​(java.lang.CharSequence name)
        Headers.get(Object) and convert the result to a String.
        Parameters:
        name - the name of the header to retrieve
        Returns:
        the first header value if the header is found. null if there's no such header.
      • getAllAsString

        java.util.List<java.lang.String> getAllAsString​(java.lang.CharSequence name)
        Headers.getAll(Object) and convert each element of List to a String.
        Parameters:
        name - the name of the header to retrieve
        Returns:
        a List of header values or an empty List if no values are found.
      • iteratorAsString

        java.util.Iterator<java.util.Map.Entry<java.lang.String,​java.lang.String>> iteratorAsString()
        Headers.iterator() that converts each Map.Entry's key and value to a String.
      • contains

        boolean contains​(java.lang.CharSequence name,
                         java.lang.CharSequence value,
                         boolean ignoreCase)
        Returns true if a header with the name and value exists, false otherwise.

        If ignoreCase is true then a case insensitive compare is done on the value.

        Parameters:
        name - the name of the header to find
        value - the value of the header to find
        ignoreCase - true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.