SingleBound (Open Traffic Sim demo classes 1.00.01 API)

java.lang.Object
- org.opentrafficsim.base.parameters.constraint.SingleBound<T>

Type Parameters:

T - value type

All Implemented Interfaces:

Constraint<T>

Direct Known Subclasses:

DualBound
```
public class SingleBound<T extends Number>
extends Object
implements Constraint<T>
```
Continuous constraints with a single bound. To allow both Double and AbstractDoubleScalar<?, ?> constraints, the generic type is restricted to Number. However, that also allows other subclasses of Number, e.g. Integer. Due to rounding and value limits from the type (e.g. Integer.MAX_VALEU), bounds may not function correctly after a call to Number.doubleValue(). To restrict the usage, the constructor is private and static factory methods for Double and AbstractDoubleScalar<?, ?> are supplied.
Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Aug 14, 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`SingleBound.Bound` Super class for classes that implement a specific numeric check.
`(package private) static class`	`SingleBound.LowerBoundExclusive<T extends Number>` Class implementing a lower exclusive bound; `value > bound`.
`(package private) static class`	`SingleBound.LowerBoundInclusive<T extends Number>` Class implementing a lower inclusive bound; `value >= bound`.
`(package private) static class`	`SingleBound.UpperBoundExclusive<T extends Number>` Class implementing an upper exclusive bound; `value < bound`.
`(package private) static class`	`SingleBound.UpperBoundInclusive<T extends Number>` Class implementing an upper inclusive bound; `value <= bound`.

Constructor Summary

Constructors
Constructor and Description

SingleBound(SingleBound.Bound bound, String failMessage)
Constructor.

Constructors
Constructor and Description
`SingleBound(SingleBound.Bound bound, String failMessage)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(T value)` Checks whether the value complies with constraints.
`String`	`failMessage()` Returns a message for value failure, pointing to a parameter using '%s'.
`SingleBound.Bound`	`getBound()`
`static SingleBound<Double>`	`lowerExclusive(double bound)` Creates a lower exclusive bound; `value > bound`.
`static <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T>`	`lowerExclusive(T bound)` Creates a lower exclusive bound; `value > bound`.
`static SingleBound<Double>`	`lowerInclusive(double bound)` Creates a lower inclusive bound; `value >= bound`.
`static <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T>`	`lowerInclusive(T bound)` Creates a lower inclusive bound; `value >= bound`.
`String`	`toString()`
`static SingleBound<Double>`	`upperExclusive(double bound)` Creates an upper exclusive bound; `value < bound`.
`static <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T>`	`upperExclusive(T bound)` Creates an upper exclusive bound; `value < bound`.
`static SingleBound<Double>`	`upperInclusive(double bound)` Creates an upper inclusive bound; `value <= bound`.
`static <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T>`	`upperInclusive(T bound)` Creates an upper inclusive bound; `value <= bound`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SingleBound
```
SingleBound(SingleBound.Bound bound,
            String failMessage)
```
    Constructor.
    
    Parameters:
    
    bound - Bound; bound
    
    failMessage - String; message about values that do not comply with the bound
- Method Detail
  - lowerInclusive
```
public static final SingleBound<Double> lowerInclusive(double bound)
```
    Creates a lower inclusive bound; value >= bound.
    
    Parameters:
    
    bound - double; bound value
    
    Returns:
    
    lower inclusive bound
  - lowerInclusive
```
public static final <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T> lowerInclusive(T bound)
```
    Creates a lower inclusive bound; value >= bound.
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    bound - AbstractDoubleScalar; bound value
    
    Returns:
    
    lower inclusive bound
  - lowerExclusive
```
public static final SingleBound<Double> lowerExclusive(double bound)
```
    Creates a lower exclusive bound; value > bound.
    
    Parameters:
    
    bound - double; bound value
    
    Returns:
    
    lower exclusive bound
  - lowerExclusive
```
public static final <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T> lowerExclusive(T bound)
```
    Creates a lower exclusive bound; value > bound.
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    bound - AbstractDoubleScalar; bound value
    
    Returns:
    
    lower exclusive bound
  - upperInclusive
```
public static final SingleBound<Double> upperInclusive(double bound)
```
    Creates an upper inclusive bound; value <= bound.
    
    Parameters:
    
    bound - double; bound value
    
    Returns:
    
    upper inclusive bound
  - upperInclusive
```
public static final <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T> upperInclusive(T bound)
```
    Creates an upper inclusive bound; value <= bound.
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    bound - AbstractDoubleScalar; bound value
    
    Returns:
    
    upper inclusive bound
  - upperExclusive
```
public static final SingleBound<Double> upperExclusive(double bound)
```
    Creates an upper exclusive bound; value < bound.
    
    Parameters:
    
    bound - double; bound value
    
    Returns:
    
    upper exclusive bound
  - upperExclusive
```
public static final <T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalar<?,?>> SingleBound<T> upperExclusive(T bound)
```
    Creates an upper exclusive bound; value < bound.
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    bound - AbstractDoubleScalar; bound value
    
    Returns:
    
    upper exclusive bound
  - accept
```
public boolean accept(T value)
```
    Checks whether the value complies with constraints.
    
    Specified by:
    
    accept in interface Constraint<T extends Number>
    
    Parameters:
    
    value - Value to check.
    
    Returns:
    
    Whether the value complies with constraints.
  - failMessage
```
public String failMessage()
```
    Returns a message for value failure, pointing to a parameter using '%s'.
    
    Specified by:
    
    failMessage in interface Constraint<T extends Number>
    
    Returns:
    
    Message for value failure, pointing to a parameter using '%s'.
  - getBound
```
public SingleBound.Bound getBound()
```
    Returns:
    
    bound.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SingleBound<T extends Number>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SingleBound

Method Detail

lowerInclusive

lowerInclusive

lowerExclusive

lowerExclusive

upperInclusive

upperInclusive

upperExclusive

upperExclusive

accept

failMessage

getBound

toString