org.flexiblepower.ral.values

Class Constraint<Q extends javax.measure.quantity.Quantity>

java.lang.Object

org.flexiblepower.ral.values.Constraint<Q>

Type Parameters:

Q - The quantity of the constraint (see the javax.measure package)

public final class Constraint<Q extends javax.measure.quantity.Quantity>
extends java.lang.Object

A Constraint represents a range of values from the lowerBound to the upperBound. This is mainly used for the ConstraintList.

Constructor Summary

Constructors

Constructor and Description
Constraint(double lowerBound, double upperBound, javax.measure.unit.Unit<Q> unit) Construct a constraint with two (different) values.
Constraint(javax.measure.Measurable<Q> value) Constructs a constraint with a single value.
Constraint(javax.measure.Measurable<Q> lowerBound, javax.measure.Measurable<Q> upperBound) Construct a constraint with a lower and upper bound expressed in the quantity.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
javax.measure.Measurable<Q>	getClosestValue(javax.measure.Measurable<Q> value)
javax.measure.Measurable<Q>	getLowerBound()
javax.measure.Measurable<Q>	getUpperBound()
int	hashCode()
boolean	isSingleValue()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Constraint

public Constraint(javax.measure.Measurable<Q> lowerBound,
          javax.measure.Measurable<Q> upperBound)

Construct a constraint with a lower and upper bound expressed in the quantity. If both are equal, this constructs a single value constraint.

Parameters:

lowerBound - is the lower bound expressed in a unit that fits with Q

upperBound - is the upper bound expressed in a unit that fits with Q

Throws:

java.lang.NullPointerException - if either the lower or upper bound is null

java.lang.IllegalArgumentException - if the upper bound is lower than the lower bound

Constraint

public Constraint(javax.measure.Measurable<Q> value)

Constructs a constraint with a single value.

Parameters:

value - is the single typed input value.

Throws:

java.lang.NullPointerException - if value is null

Constraint

public Constraint(double lowerBound,
          double upperBound,
          javax.measure.unit.Unit<Q> unit)

Construct a constraint with two (different) values. If both are equal, this constructs a single value constraint.

Parameters:

lowerBound - is the lower bound

upperBound - is the upper bound

unit - is unit in which both the lower and upper bound are expressed

Throws:

java.lang.NullPointerException - when unit is null

Method Detail

isSingleValue

public boolean isSingleValue()

Returns:

true when the lower and upper bound are equal, this this represents as single value.

getLowerBound

public javax.measure.Measurable<Q> getLowerBound()

Returns:

The lower bound of the constraint

getUpperBound

public javax.measure.Measurable<Q> getUpperBound()

Returns:

The upper bound of the constraint, which will be equal to the lower bound if this represents a single value.

getClosestValue

public javax.measure.Measurable<Q> getClosestValue(javax.measure.Measurable<Q> value)

Parameters:

value - The value that we want to match

Returns:

The value that lies the closest to the bounds that are given. If the value is lower than the lower bound, than the lower bound is returned. If the value is higher that the upper bound, than the upper bound is returned. If the value is in between the bounds, the value itself is returned.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object