de.bioforscher.singa.core.parameters

Class BooleanParameter

java.lang.Object

de.bioforscher.singa.core.parameters.BooleanParameter

All Implemented Interfaces:

Parameter<Boolean>, Bounded<Boolean>, Nameable

public final class BooleanParameter
extends Object
implements Parameter<Boolean>

Constructor Summary

Constructors

Constructor and Description
BooleanParameter(String name)

Method Summary

Modifier and Type	Method and Description
Boolean	getLowerBound() Returns the lower bound specified for this object.
String	getName() Returns the name, by which the object can be referenced.
Boolean	getUpperBound() Returns the upper bound specified for this object.
boolean	isInRange(Boolean value) Checks whether the given value is larger than the lower bound and smaller than the upper bound specified for this object.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.bioforscher.singa.core.utility.Bounded

assertIfValueInRange

Constructor Detail

BooleanParameter

public BooleanParameter(String name)

Method Detail

getName

public String getName()

Description copied from interface: Nameable

Returns the name, by which the object can be referenced.

Specified by:

getName in interface Nameable

Returns:

The name of the object.

toString

public String toString()

Overrides:

toString in class Object

getLowerBound

public Boolean getLowerBound()

Description copied from interface: Bounded

Returns the lower bound specified for this object.

Specified by:

getLowerBound in interface Bounded<Boolean>

Returns:

The lower bound specified for this object.

getUpperBound

public Boolean getUpperBound()

Description copied from interface: Bounded

Returns the upper bound specified for this object.

Specified by:

getUpperBound in interface Bounded<Boolean>

Returns:

The upper bound specified for this object.

isInRange

public boolean isInRange(Boolean value)

Description copied from interface: Bounded

Checks whether the given value is larger than the lower bound and smaller than the upper bound specified for this object.

Specified by:

isInRange in interface Bounded<Boolean>

Parameters:

value - The value to be checked.

Returns:

true if the constraints are met.