Inspectopedia
 
2024.3

Return value is outside of declared range

Warning
New
Last modified: 03 December 2024

Reports numeric values returned from methods that don't conform to the declared method return range. You can declare method return range using a number of annotations:

  • org.jetbrains.annotations.Range from JetBrains annotations package (specify 'from' and 'to')

  • org.checkerframework.common.value.qual.IntRange from Checker Framework annotations package (specify 'from' and 'to')

  • org.checkerframework.checker.index.qual.GTENegativeOne from Checker Framework annotations package (range is '>= -1')

  • org.checkerframework.checker.index.qual.NonNegative from Checker Framework annotations package (range is '>= 0')

  • org.checkerframework.checker.index.qual.Positive from Checker Framework annotations package (range is '> 0')

  • javax.annotation.Nonnegative from JSR 305 annotations package (range is '>= 0')

  • javax.validation.constraints.Min (specify minimum value)

  • javax.validation.constraints.Max (specify maximum value)

Example:

New in 2021.2