Package com.storedobject.common

Interface ComputedValue<T>

Type Parameters:

T - the type of the value managed by this interface

All Superinterfaces:

Cloneable, Displayable

All Known Implementing Classes:

AbstractComputedInteger, AbstractComputedValue, ComputedDate, ComputedDouble, ComputedInteger, ComputedLong, ComputedMinute

public interface ComputedValue<T>
extends Cloneable, Displayable

The ComputedValue interface represents a value that supports computational state, providing mechanisms to check and modify whether the value is computed or manually set. It extends the Cloneable interface to allow object cloning and the Displayable interface for a displayable representation of the value.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
ComputedValue<T>	clone()	Creates and returns a copy of this ComputedValue instance.
default boolean	consider()	Evaluates the current state of the value to determine whether it is not in a computed state.
default void	consider(boolean consider)	Sets the computed state of the value based on the provided consideration.
default void	enable(boolean enable)	Enables or disables a certain state by changing the computed state of the value.
T	getValueObject()	Retrieves the value object associated with this instance.
default boolean	ignore()	Checks whether the current value should be ignored based on its computed state.
default void	ignore(boolean ignore)	Sets the computed state of the value based on the provided ignore flag.
boolean	isComputed()	Determines whether the current value is in a computed state.
default boolean	isManual()	Determines whether the current value is set manually.
default void	reverseStatus()	Reverses the state of the current value based on its ignore status.
void	setComputed(boolean computed)	Sets the computed state of the value.
default void	setManual(boolean manual)	Sets the manual state of the value.
void	setValue(T value)	Sets the value for the current instance.

Methods inherited from interface com.storedobject.common.Displayable

toDisplay

Method Details

isComputed

boolean isComputed()

Determines whether the current value is in a computed state.

Returns:

true if the value is computed, false if it is manually set or not computed.

setComputed

void setComputed(boolean computed)

Sets the computed state of the value.

Parameters:

computed - if true, marks the value as computed; if false, marks the value as manually set or non-computed.

isManual

default boolean isManual()

Determines whether the current value is set manually.

Returns:

true if the value is manually set, false if it is in a computed state.

consider

default boolean consider()

Evaluates the current state of the value to determine whether it is not in a computed state.

Returns:

true if the value is not computed (i.e., manually set or non-computed), false otherwise.

consider

default void consider(boolean consider)

Sets the computed state of the value based on the provided consideration. If consider is true, the computed state is set to false, indicating a manual state. If consider is false, the computed state is set to true.

Parameters:

consider - true to mark the value as not computed (manually set), false to mark it as computed.

ignore

default boolean ignore()

Checks whether the current value should be ignored based on its computed state.

Returns:

true if the value is in a computed state and should be ignored; false if it is not computed and should not be ignored.

ignore

default void ignore(boolean ignore)

Sets the computed state of the value based on the provided ignore flag. If ignore is true, the computed state is set to true, marking the value as computed. If ignore is false, the computed state is set to false, marking the value as manually set or non-computed.

Parameters:

ignore - true to mark the value as computed and ignored; false to mark it as manually set and not ignored.

setManual

default void setManual(boolean manual)

Sets the manual state of the value. When the value is set to manual, its computed state is automatically negated.

Parameters:

manual - true to mark the value as manually set, false to mark it as in a computed state.

enable

default void enable(boolean enable)

Enables or disables a certain state by changing the computed state of the value. If the enable parameter is true, the computed state is set to false. If the enable parameter is false, the computed state is set to true.

Parameters:

enable - true to enable the state by setting the value as not computed; false to disable the state by setting the value as computed.

reverseStatus

default void reverseStatus()

Reverses the state of the current value based on its ignore status. If the value is currently ignored (computed state), it updates the state to be considered (not computed). Otherwise, it updates the state to be ignored (computed).

setValue

void setValue(T value)

Sets the value for the current instance. The provided value may be manually set or used in conjunction with the computed state of the object, depending on other methods and logic in the class.

Parameters:

value - the value to be set for the current instance

getValueObject

T getValueObject()

Retrieves the value object associated with this instance.

Returns:

the value object of type T.

clone

ComputedValue<T> clone()
                throws CloneNotSupportedException

Creates and returns a copy of this ComputedValue instance. The cloned object is a new instance identical to the original, maintaining the same state and value.

Returns:

a new ComputedValue<T> instance that is a copy of the current object

Throws:

CloneNotSupportedException - if the object's class does not support cloning