public interface HandleUserProperties
An interface that describe an object that can handle user properties.
- Since:
- 1.0.9
- Version:
- "1.0.14" - b202111241200L
- Author:
- Julien SEINTURIER - Université de Toulon / CNRS LIS umr 7020 - github.com/jorigin/jcommon (contact@jorigin.org)
-
Method Summary
Modifier and TypeMethodDescriptionvoidClear the user properties associated to this object.getUserProperty(String propertyName) Get the user property mapped with the givenname.Get the list of the names of all properties attached to this object.setUserProperty(String name, Object value) Set the user property mapped with the givennameto the givenvalue.
-
Method Details
-
getUserProperty
Get the user property mapped with the givenname. If no property is mapped,nullis returned.- Parameters:
propertyName- the name of the property.- Returns:
- the user property mapped with the given
name. If no property is mapped,nullis returned. - See Also:
-
setUserProperty
Set the user property mapped with the givennameto the givenvalue. 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:
-
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.
-