org.jorigin.property.HandleUserProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcommon Show documentation

A java common package that enable to deal with various functionalities

There is a newer version: 1.0.14

package org.jorigin.property;

import java.util.List;

import org.jorigin.Common;

/**
 * An interface that describe an object that can handle user properties.
 * @author Julien Seinturier - COMEX S.A. - [email protected] - https://github.com/jorigin/jeometry
 * @version {@value Common#version} - b{@value Common#BUILD}
 * @since 1.0.9
 */
public interface HandleUserProperties {

	/**
	 * Get the user property mapped with the given name. If no property is mapped, null is returned.
	 * @param propertyName the name of the property.
	 * @return the user property mapped with the given name. If no property is mapped, null is returned.
	 * @see #setUserProperty(String, Object)
	 */
	public Object getUserProperty(String propertyName);
	
	/**
	 * 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.
	 * @param name the name of the property.
	 * @param value the value of the property.
	 * @return the old value of the property that was mapped.
	 * @see #getUserProperty(String)
	 */
	public Object setUserProperty(String name, Object value);
	
	/**
	 * Get the list of the names of all properties attached to this object.
	 * @return the list of the names of all properties attached to this object.
	 */
	public List getUserPropertyNames();
	
	/**
	 * Clear the user properties associated to this object.
	 */
	public void clearUserProperties();
}