Interface HandleUserProperties

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearUserProperties()
      Clear the user properties associated to this object.
      java.lang.Object getUserProperty​(java.lang.String propertyName)
      Get the user property mapped with the given name.
      java.util.List<java.lang.String> getUserPropertyNames()
      Get the list of the names of all properties attached to this object.
      java.lang.Object setUserProperty​(java.lang.String name, java.lang.Object value)
      Set the user property mapped with the given name to the given value.
    • Method Detail

      • getUserProperty

        java.lang.Object getUserProperty​(java.lang.String propertyName)
        Get the user property mapped with the given name. If no property is mapped, null is returned.
        Parameters:
        propertyName - the name of the property.
        Returns:
        the user property mapped with the given name. If no property is mapped, null is returned.
        See Also:
        setUserProperty(String, Object)
      • setUserProperty

        java.lang.Object setUserProperty​(java.lang.String name,
                                         java.lang.Object value)
        Set the user property mapped with the given name to the given value. If a property is already mapped with this name, the old value is returned.
        Parameters:
        name - the name of the property.
        value - the value of the property.
        Returns:
        the old value of the property that was mapped.
        See Also:
        getUserProperty(String)
      • getUserPropertyNames

        java.util.List<java.lang.String> getUserPropertyNames()
        Get the list of the names of all properties attached to this object.
        Returns:
        the list of the names of all properties attached to this object.
      • clearUserProperties

        void clearUserProperties()
        Clear the user properties associated to this object.