Package io.cui.tools.base

Class Preconditions

  • public final class Preconditions
extends Object
    Inspired by com.google.common.base.Preconditions. Defines a subset of the corresponding Preconditions
    Author:
    com.google.common.base.Preconditions, Oliver Wolff

    • Method Summary

      All Methods Static Methods Concrete Methods 
      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, String message)
      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 void checkState​(boolean expression)
      Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
      static void checkState​(boolean expression, String message)
      Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
      static void checkState​(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)
      Ensures the truth of an expression involving one or more parameters to the calling method.

    • Method Detail

      • 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

      • checkArgument

        public static void checkArgument​(boolean expression,
                                 String message)
        Ensures the truth of an expression involving one or more parameters to the calling method.
        Parameters:
        expression - a boolean expression
        message - to be put into the create IllegalArgumentException
        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

      • checkState

        public static void checkState​(boolean expression)
        Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
        Parameters:
        expression - a boolean expression
        Throws:
        IllegalStateException - if expression is false

      • checkState

        public static void checkState​(boolean expression,
                              String message)
        Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
        Parameters:
        expression - a boolean expression
        message - to be put into the create IllegalStateException
        Throws:
        IllegalStateException - if expression is false

      • checkState

        public static void checkState​(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:
        IllegalStateException - if expression is false