edu.neu.ccs.filter
Class MaximumBoundFilter.Double

java.lang.Object
  extended byedu.neu.ccs.filter.NumericFilter
      extended byedu.neu.ccs.filter.BoundFilter
          extended byedu.neu.ccs.filter.MaximumBoundFilter
              extended byedu.neu.ccs.filter.MaximumBoundFilter.Double
All Implemented Interfaces:
Cloneable, Serializable, StringableFilter
Enclosing class:
MaximumBoundFilter

public static class MaximumBoundFilter.Double
extends MaximumBoundFilter

Maximum bound filter representing a real number upper bound of primitive precision.

Since:
1.0
Version:
2.1
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class edu.neu.ccs.filter.MaximumBoundFilter
MaximumBoundFilter.BigDecimal, MaximumBoundFilter.BigInteger, MaximumBoundFilter.Double, MaximumBoundFilter.Long
 
Field Summary
protected  double maximum
          The maximum bound for the range.
 
Fields inherited from class edu.neu.ccs.filter.MaximumBoundFilter
MAXIMUM
 
Fields inherited from class edu.neu.ccs.filter.BoundFilter
inclusive, INCLUSIVE
 
Fields inherited from class edu.neu.ccs.filter.NumericFilter
changeAdapter
 
Constructor Summary
MaximumBoundFilter.Double(double max)
          Constructs an inclusive range bounded by the given maximum value.
MaximumBoundFilter.Double(double max, boolean isInclusive)
          Constructs an inclusive or exclusive range bounded by the given maximum value.
 
Method Summary
 Stringable filterStringable(Stringable obj)
          Returns the given object if it satisfies the bound for this range.
 double getMaximum()
          Returns the maximum bound for this range.
 void setMaximum(double max)
          Sets the maximum bound for the range to the given value.
 
Methods inherited from class edu.neu.ccs.filter.BoundFilter
isInclusive, setInclusive
 
Methods inherited from class edu.neu.ccs.filter.NumericFilter
addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

maximum

protected double maximum
The maximum bound for the range.

Constructor Detail

MaximumBoundFilter.Double

public MaximumBoundFilter.Double(double max)
Constructs an inclusive range bounded by the given maximum value.

Parameters:
max - the maximum value for the range

MaximumBoundFilter.Double

public MaximumBoundFilter.Double(double max,
                                 boolean isInclusive)
Constructs an inclusive or exclusive range bounded by the given maximum value.

Parameters:
max - the maximum value for the range
isInclusive - whether or not the range is inclusive
Method Detail

filterStringable

public Stringable filterStringable(Stringable obj)
                            throws FilterException
Returns the given object if it satisfies the bound for this range.

Specified by:
filterStringable in interface StringableFilter
Overrides:
filterStringable in class NumericFilter
Parameters:
obj - the object to be filtered
Throws:
FilterException - if the object is out of bounds

setMaximum

public void setMaximum(double max)
Sets the maximum bound for the range to the given value.

Parameters:
max - the desired maximum bound
See Also:
getMaximum()

getMaximum

public double getMaximum()
Returns the maximum bound for this range.

See Also:
setMaximum(double)