Package com.im.df.api.capabilities

Interface XAttributeCapability

  • All Superinterfaces:
    DFCapability
    public interface XAttributeCapability
extends DFCapability
    A Capability providing methods for accessing XAttributes key-value pairs (<String, String>).
    Author:
    MiloslavSram

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROP_XATTRIBUTES
      Property whose change is fired on any change of extra attribute.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearXAttribute​(java.lang.String key, com.im.commons.progress.DFEnvironmentRW env)
      Clears the XAttribute of given key.
      java.lang.String getXAttribute​(java.lang.String key)
      Gets the value of given XAttribute.
      java.util.Map<java.lang.String,​java.lang.String> getXAttributes()
      Returns a Map of all XAttributes.
      void putXAttribute​(java.lang.String key, java.lang.String value, com.im.commons.progress.DFEnvironmentRW env)
      Sets the XAttribute of given key-value pair.

    • Field Detail

      • PROP_XATTRIBUTES

        static final java.lang.String PROP_XATTRIBUTES
        Property whose change is fired on any change of extra attribute.
        See Also:
        Constant Field Values

    • Method Detail

      • putXAttribute

        void putXAttribute​(java.lang.String key,
                   java.lang.String value,
                   com.im.commons.progress.DFEnvironmentRW env)
        Sets the XAttribute of given key-value pair.
        Parameters:
        key - The key of XAttribute to be set.
        value - The value of XAttribute to be set.
        env - The environment under which the clearXAttribute should be performed

      • getXAttribute

        java.lang.String getXAttribute​(java.lang.String key)
        Gets the value of given XAttribute.
        Parameters:
        key - The key of XAttribute.
        Returns:
        The value of XAttributes

      • getXAttributes

        java.util.Map<java.lang.String,​java.lang.String> getXAttributes()
        Returns a Map of all XAttributes.
        Returns:
        Map of XAttributes

      • clearXAttribute

        void clearXAttribute​(java.lang.String key,
                     com.im.commons.progress.DFEnvironmentRW env)
        Clears the XAttribute of given key.
        Parameters:
        key - The key of XAttribute to clear.
        env - The environment under which the clearXAttribute should be performed