Class Assertions


  • public class Assertions
    extends Object
    • Constructor Detail

      • Assertions

        public Assertions()
    • Method Detail

      • assertNotNull

        public static <T> T assertNotNull​(@Nullable
                                          T object,
                                          String explanation)
        Assertion with a runtime check.
      • assertNotNull

        public static <T> T assertNotNull​(@Nullable
                                          T object)
        See #assertNotNull(T object, String explanation).

        NOTE: prefer always providing an explanation.

      • assumeNotNull

        public static <T> T assumeNotNull​(@Nullable
                                          T object,
                                          String explanation)
        Same as #assertNotNull(), but does not do a runtime check. Useful in performance-critical places when a runtime check is costly.

        NOTE: Whenever possible, prefer using #assertNotNull(). Java runtime is doing a good job with optimizing nullability checks, so most likely this won't improve performance, but will make unexpected null propagate and hide the real cause of an error.

      • assumeNotNull

        public static <T> T assumeNotNull​(@Nullable
                                          T object)
        See #assumeNotNull(T object, String explanation).

        NOTE: prefer always providing an explanation.

      • nullsafeFIXME

        public static <T> T nullsafeFIXME​(@Nullable
                                          T object,
                                          String explanationOrTask)
        Makes Nullsafe stop complaining when object is dereferenced or converted to a non-nullable. In contrast with #assumeNotNull(), indicates cases when the proper fix needs to be committed, but for some reason it is hard or impossible to do it staight away.
      • assertGet

        public static <T> T assertGet​(int index,
                                      List<T> list)
      • assertGet

        public static <K,​V> V assertGet​(K key,
                                              Map<K,​V> map)
      • assumeCondition

        public static void assumeCondition​(boolean condition)
      • assumeCondition

        public static void assumeCondition​(boolean condition,
                                           String explanation)
      • assertCondition

        public static void assertCondition​(boolean condition)
      • assertCondition

        public static void assertCondition​(boolean condition,
                                           String explanation)
      • assertUnreachable

        public static AssertionError assertUnreachable()