org.cytoscape.work.util
Class BoundedInteger

java.lang.Object
  org.cytoscape.work.util.AbstractBounded<Integer>
      org.cytoscape.work.util.BoundedInteger

public final class BoundedInteger
extends AbstractBounded<Integer>

An Integer object which has low and up bounds.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: work-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>work-api</artifactId>
</dependency>

Constructor Summary

BoundedInteger(Integer lower, Integer initValue, Integer upper, boolean lowerStrict, boolean upperStrict)
Creates a new Bounded Integer object.

Method Summary

Integer	clamp(Integer value) Clamp the value to be within the range.
void	setValue(String s) Set a new value to the BoundedInteger object

Methods inherited from class org.cytoscape.work.util.AbstractBounded

addListener, getLowerBound, getUpperBound, getValue, isLowerBoundStrict, isUpperBoundStrict, removeListener, setBounds, setLowerBoundStrict, setUpperBoundStrict, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedInteger

public BoundedInteger(Integer lower,
                      Integer initValue,
                      Integer upper,
                      boolean lowerStrict,
                      boolean upperStrict)

Creates a new Bounded Integer object.

Parameters:

lower - The lower bound value.

initValue - Initial of default value for the Integer

upper - The upper bound value

lowerStrict - True means that the value cannot be equal to the lower bound

upperStrict - True means that the value cannot be equal to the upper bound

Method Detail

setValue

public void setValue(String s)

Set a new value to the BoundedInteger object

Specified by:

setValue in class AbstractBounded<Integer>

Parameters:

s - String converted into Integer

clamp

public Integer clamp(Integer value)

Clamp the value to be within the range.

Specified by:

clamp in class AbstractBounded<Integer>