org.jorigin.state.HandleActivation 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.9

package org.jorigin.state;

import org.jorigin.Common;

/**
 * An interface that describe an object that can be activated.
 * @author Julien SEINTURIER - Université de Toulon / CNRS LIS umr 7020 - github.com/jorigin/jcommon ([email protected])
 * @version {@value Common#version} - b{@value Common#BUILD}
 * @since 1.0.11
 */
public interface HandleActivation {
	/**
	 * Get if the object is activated.
	 * @return true if the object is activated and false otherwise.
	 * @see #isStateActivable()
	 * @see #setStateActivated(boolean)
	 */
	public boolean isStateActivated();
	
	/**
	 * Set if the object is activated. 
	 * This method has to modify the activation state only if its {@link #isStateActivable() activability} is set to true
	 * @param activated true if the object can be activated and false otherwise.
	 * @see #setStateActivable(boolean)
	 * @see #isStateActivated()
	 */
	public void setStateActivated(boolean activated);
	
	/**
	 * Get if the object can be activated. 
	 * @return true if the object activation state can be modified and false otherwise.
	 * @see #isStateActivated()
	 * @see #setStateActivable(boolean)
	 */
	public boolean isStateActivable();
	
	/**
	 * Set if the object can be activated. 
	 * @param activable true if the object activation state can be modified and false otherwise.
	 * @see #setStateActivated(boolean)
	 * @see #isStateActivable()
	 */
	public void setStateActivable(boolean activable);
}