org.cytoscape.work.util

Class BoundedLong

java.lang.Object

org.cytoscape.work.util.AbstractBounded<Long>

org.cytoscape.work.util.BoundedLong

public final class BoundedLong
extends AbstractBounded<Long>

A Long 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

Constructors

Constructor and Description
BoundedLong(Long lower, Long initValue, Long upper, boolean lowerStrict, boolean upperStrict) Creates a new Bounded Long object.

Method Summary

Modifier and Type	Method and Description
Long	clamp(Long value) Clamp the value to be within the range.
void	setValue(String s) Set a new value to the BoundedLong 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

BoundedLong

public BoundedLong(Long lower,
                   Long initValue,
                   Long upper,
                   boolean lowerStrict,
                   boolean upperStrict)

Creates a new Bounded Long object.

Parameters:

lower - The lower bound value.

initValue - Initial of default value for the Long.

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 BoundedLong object.

Specified by:

setValue in class AbstractBounded<Long>

Parameters:

s - String converted into Long.

clamp

public Long clamp(Long value)

Clamp the value to be within the range.

Specified by:

clamp in class AbstractBounded<Long>