Package com.storedobject.common

Class Range<T>

java.lang.Object

com.storedobject.common.Range<T>

Type Parameters:

T - the type of the values representing the range boundaries

Direct Known Subclasses:

AbstractPeriod, IntegerRange, LongRange

public abstract class Range<T>
extends Object

Represents a generic range of values of type T. This abstract class is intended to be extended by specific range implementations that define behavior for particular types. The range is defined by two endpoints: a starting point ("from") and an ending point ("to").

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	from	Represents the starting point of the range.
protected final T	to	Represents the starting point of the range.

Constructor Summary

Constructors

Constructor	Description
Range(T from, T to)	Constructs a new Range instance with the specified start and end values.

Method Summary

Modifier and Type	Method	Description
protected T	clone(T data)	Creates a shallow copy of the provided object.
final boolean	equals(Object another)
final boolean	equals(T from, T to)	Compares the given range boundaries with the current range for equality.
T	getFrom()	Retrieves the starting value of the range.
T	getTo()	Retrieves the ending value of the range.
boolean	isValid()	Checks if the range is considered valid based on its boundaries.
protected boolean	same(T one, T two)	Compares two objects of type T for equality.
String	toString()
protected String	toString(T data)	Converts the provided data of type T to its string representation.
protected long	value(T data)	Calculates a numeric representation of the given data.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

from

protected final T from

Represents the starting point of the range. This variable defines the inclusive lower boundary of the range for the specified type T. It is immutable and retains the initial value provided at the time of instantiation of the range. The interpretation of the value is specific to the type T and may depend on the implementation of the subclass. For example, in a numeric range, this could represent the minimum value, while in a date range, this could represent the earlier date. The variable is protected, allowing access to subclasses of Range, and final, ensuring that its value cannot be modified after initialization.

to

protected final T to

Represents the starting point of the range. This variable defines the inclusive lower boundary of the range for the specified type T. It is immutable and retains the initial value provided at the time of instantiation of the range. The interpretation of the value is specific to the type T and may depend on the implementation of the subclass. For example, in a numeric range, this could represent the minimum value, while in a date range, this could represent the earlier date. The variable is protected, allowing access to subclasses of Range, and final, ensuring that its value cannot be modified after initialization.

Constructor Details

Range

public Range(T from,
 T to)

Constructs a new Range instance with the specified start and end values.

Parameters:

from - the starting value of the range; must be of type T

to - the ending value of the range; must be of type T

Method Details

getFrom

public T getFrom()

Retrieves the starting value of the range.

Returns:

the starting value of the range, cloned from the internal "from" field

getTo

public T getTo()

Retrieves the ending value of the range.

Returns:

the ending value of the range, cloned from the internal "to" field

clone

protected T clone(T data)

Creates a shallow copy of the provided object. This method is used to generate a clone of the specified input object of the same type.

Parameters:

data - the object to be cloned; must be of type T

Returns:

a shallow copy of the input object

equals

public final boolean equals(Object another)

Overrides:

equals in class Object

equals

public final boolean equals(T from,
 T to)

Compares the given range boundaries with the current range for equality.

Parameters:

from - the starting value of the range to compare; can be null

to - the ending value of the range to compare; can be null

Returns:

true if both the starting and ending values match the current range; false otherwise

same

protected boolean same(T one,
 T two)

Compares two objects of type T for equality.

Parameters:

one - the first object to compare; can be null

two - the second object to compare; can be null

Returns:

true if both objects are equal or both are null; false otherwise

isValid

public boolean isValid()

Checks if the range is considered valid based on its boundaries. A range is valid if neither boundary is null and one of the following is true: the starting boundary value is less than the ending boundary value, or both boundaries are considered equal.

Returns:

true if the range is valid; false otherwise

value

protected long value(T data)

Calculates a numeric representation of the given data. The implementation currently returns a default value.

Parameters:

data - the input data, potentially used to determine the numeric value; must be of type T

Returns:

a numeric representation of the input data, which is currently a fixed value of 0L

toString

protected String toString(T data)

Converts the provided data of type T to its string representation.

Parameters:

data - the input data to convert; can be null

Returns:

an empty string if the input data is null, otherwise the string representation of the data

toString

public String toString()

Overrides:

toString in class Object