Package org.refcodes.structure

Interface Range<V extends java.lang.Number & java.lang.Comparable<V>>

  • Type Parameters:
    V - The type used for the values.
    All Superinterfaces:
    org.refcodes.mixin.MaxValueAccessor<V>, org.refcodes.mixin.MinValueAccessor<V>
    All Known Subinterfaces:
    Range.RangeBuilder<V>
    All Known Implementing Classes:
    RangeImpl, RangeImpl.RangeBuilderImpl

    public interface Range<V extends java.lang.Number & java.lang.Comparable<V>>
extends org.refcodes.mixin.MinValueAccessor<V>, org.refcodes.mixin.MaxValueAccessor<V>
    Interface describing a range with a minimum value and a maximum value.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  Range.RangeBuilder<V extends java.lang.Number & java.lang.Comparable<V>>
      Adds builder functionality to a Range.

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.MaxValueAccessor

        org.refcodes.mixin.MaxValueAccessor.MaxValueBuilder<V extends java.lang.Object,B extends org.refcodes.mixin.MaxValueAccessor.MaxValueBuilder<V,B>>, org.refcodes.mixin.MaxValueAccessor.MaxValueMutator<V extends java.lang.Object>, org.refcodes.mixin.MaxValueAccessor.MaxValueProperty<V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.MinValueAccessor

        org.refcodes.mixin.MinValueAccessor.MinValueBuilder<V extends java.lang.Object,B extends org.refcodes.mixin.MinValueAccessor.MinValueBuilder<V,B>>, org.refcodes.mixin.MinValueAccessor.MinValueMutator<V extends java.lang.Object>, org.refcodes.mixin.MinValueAccessor.MinValueProperty<V extends java.lang.Object>

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default boolean isMember​(V aValue)
      Returns true if the given value is within the range of MinValueAccessor.getMinValue() and MaxValueAccessor.getMaxValue() (including the minimum and maximum values).

      • Methods inherited from interface org.refcodes.mixin.MaxValueAccessor

        getMaxValue

      • Methods inherited from interface org.refcodes.mixin.MinValueAccessor

        getMinValue

    • Method Detail

      • isMember

        default boolean isMember​(V aValue)
        Returns true if the given value is within the range of MinValueAccessor.getMinValue() and MaxValueAccessor.getMaxValue() (including the minimum and maximum values).
        Parameters:
        aValue - The value to test whether it is in range.
        Returns:
        True in case of being in range, else false.