SmallerArgumentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

ch.nolix.baseapi.errorcontrol.invalidargumentexception.AbstractInvalidArgumentException

ch.nolix.baseapi.errorcontrol.invalidargumentexception.SmallerArgumentException

All Implemented Interfaces:: Serializable

public final class SmallerArgumentException extends AbstractInvalidArgumentException

A SmallerArgumentException is a AbstractInvalidArgumentException that is supposed to be thrown when a given argument is undesirably smaller than a given min.

Author:

Silvan Wyss

See Also:

Method Summary

Modifier and Type

Method

Description

static SmallerArgumentException

forArgumentAndArgumentNameAndLimit(BigDecimal argument, String argumentName, BigDecimal limit)

static SmallerArgumentException

forArgumentAndArgumentNameAndMin(double argument, String argumentName, double min)

Methods inherited from class AbstractInvalidArgumentException
getArgumentName, getErrorPredicate, getStoredArgument

Methods inherited from class Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- forArgumentAndArgumentNameAndLimit
  
  public static SmallerArgumentException forArgumentAndArgumentNameAndLimit(BigDecimal argument, String argumentName, BigDecimal limit)
  
  Parameters:
  
  argument -
  
  argumentName -
  
  limit -
  
  Returns:
  
  a new SmallerArgumentException for the given argument, argumentName and limit.
  
  Throws:
  
  RuntimeException - if the given argumentName is null or blank.
  
  RuntimeException - if the given limit is null.
- forArgumentAndArgumentNameAndMin
  
  public static SmallerArgumentException forArgumentAndArgumentNameAndMin(double argument, String argumentName, double min)
  
  Parameters:
  
  argument -
  
  argumentName -
  
  min -
  
  Returns:
  
  a new SmallerArgumentException for the given argument, argumentName and min.
  
  Throws:
  
  RuntimeException - if the given argumentName is null or blank.