Package org.apache.activemq.artemis.utils

Class Preconditions

java.lang.Object
org.apache.activemq.artemis.utils.Preconditions
public class Preconditions extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    Preconditions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    checkArgument(boolean expression)
    Ensures the truth of an expression involving one or more parameters to the calling method.
    static void
    checkArgument(boolean expression, Object errorMessage)
    Ensures the truth of an expression involving one or more parameters to the calling method.
    static void
    checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)
    Ensures the truth of an expression involving one or more parameters to the calling method.
    static <T> T
    checkNotNull(T reference)
    Ensures that an object reference passed as a parameter to the calling method is not null.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Preconditions

      public Preconditions()

  • Method Details

    • checkNotNull

      public static <T> T checkNotNull(T reference)
      Ensures that an object reference passed as a parameter to the calling method is not null.
      Parameters:
      reference - an object reference
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkArgument

      public static void checkArgument(boolean expression, Object errorMessage)
      Ensures the truth of an expression involving one or more parameters to the calling method.
      Parameters:
      expression - a boolean expression
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Throws:
      IllegalArgumentException - if expression is false

    • checkArgument

      public static void checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)
      Ensures the truth of an expression involving one or more parameters to the calling method.
      Parameters:
      expression - a boolean expression
      errorMessageTemplate - a template for the exception message should the check fail. The message is formed by replacing each %s placeholder in the template with an argument. These are matched by position - the first %s gets errorMessageArgs[0], etc. Unmatched arguments will be appended to the formatted message in square braces. Unmatched placeholders will be left as-is.
      errorMessageArgs - the arguments to be substituted into the message template. Arguments are converted to strings using String.valueOf(Object).
      Throws:
      IllegalArgumentException - if expression is false
      NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)

    • checkArgument

      public static void checkArgument(boolean expression)
      Ensures the truth of an expression involving one or more parameters to the calling method.
      Parameters:
      expression - a boolean expression
      Throws:
      IllegalArgumentException - if expression is false