org.libj.util.retry.RetryOn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of util Show documentation

Supplementary utilities for classes that belong to java.util, or are considered essential as to justify existence in java.util.

The newest version!

/* Copyright (c) 2021 LibJ
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * You should have received a copy of The MIT License (MIT) along with this
 * program. If not, see .
 */

package org.libj.util.retry;

/**
 * Function that specifies the conditions under which a retry should occur given the provided {@link Exception}.
 */
@FunctionalInterface
public interface RetryOn {
  /**
   * Specifies the conditions under which a retry should occur given the provided {@link Exception}.
   *
   * @param e The non-null exception that occurred during execution of a {@link Retryable} object.
   * @return {@code true} if a retry should occur, otherwise {@code false}.
   */
  boolean retryOn(Exception e);
}