Package org.apache.qpid.protonj2.engine.impl

Class ProtonAttachments

  • All Implemented Interfaces:
    Attachments
    public class ProtonAttachments
extends java.lang.Object
implements Attachments
    Proton implementation of an Attachments object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Attachments clear()  
      boolean containsKey​(java.lang.String key)
      Checks if the given key has a value mapped to it in this Attachments instance.
      <T> T get​(java.lang.String key)
      Gets the user attached value that is associated with the given key, or null if no data is mapped to the key.
      <T> T get​(java.lang.String key, java.lang.Class<T> typeClass)
      Gets the user set Attachments value that is associated with the given key, or null if no data is mapped to the key.
      ProtonAttachments set​(java.lang.String key, java.lang.Object value)
      Maps a given object to the given key in this Attachments instance.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ProtonAttachments

        public ProtonAttachments()

    • Method Detail

      • get

        public <T> T get​(java.lang.String key)
        Description copied from interface: Attachments
        Gets the user attached value that is associated with the given key, or null if no data is mapped to the key.
        Specified by:
        get in interface Attachments
        Type Parameters:
        T - The type to cast the attached mapped value to if one is set.
        Parameters:
        key - The key to use to lookup the mapped data.
        Returns:
        the object associated with the given key in this Attachments instance.

      • get

        public <T> T get​(java.lang.String key,
                 java.lang.Class<T> typeClass)
        Description copied from interface: Attachments
        Gets the user set Attachments value that is associated with the given key, or null if no data is mapped to the key.
        Specified by:
        get in interface Attachments
        Type Parameters:
        T - The type to cast the attached mapped value to if one is set.
        Parameters:
        key - The key to use to lookup the mapped data.
        typeClass - The Class that will be used when casting the returned mapped object.
        Returns:
        the object associated with the given key in this Attachments instance.

      • set

        public ProtonAttachments set​(java.lang.String key,
                             java.lang.Object value)
        Description copied from interface: Attachments
        Maps a given object to the given key in this Attachments instance.
        Specified by:
        set in interface Attachments
        Parameters:
        key - The key to assign the value to
        value - The value to map to the given key.
        Returns:
        this Attachments instance.

      • containsKey

        public boolean containsKey​(java.lang.String key)
        Description copied from interface: Attachments
        Checks if the given key has a value mapped to it in this Attachments instance.
        Specified by:
        containsKey in interface Attachments
        Parameters:
        key - The key to search for a mapping to in this Attachments instance.
        Returns:
        true if there is a value mapped to the given key in this Attachments instance.