1 /* 2 * Copyright 2017 Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google LLC nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 package com.google.api.gax.retrying; 32 33 import java.util.concurrent.CancellationException; 34 35 /** 36 * Same as {@link TimedRetryAlgorithmWithContext}, but without methods that accept a {@link 37 * RetryingContext}. Use {@link TimedRetryAlgorithmWithContext} instead of this interface when 38 * possible. 39 */ 40 public interface TimedRetryAlgorithm { 41 42 /** 43 * Same as {@link TimedRetryAlgorithmWithContext#createFirstAttempt(RetryingContext)}, but without 44 * a {@link RetryingContext}. 45 * 46 * <p>Use {@link TimedRetryAlgorithmWithContext#createFirstAttempt(RetryingContext)} instead of 47 * this method when possible. 48 */ createFirstAttempt()49 TimedAttemptSettings createFirstAttempt(); 50 51 /** 52 * Same as {@link TimedRetryAlgorithmWithContext#createNextAttempt(RetryingContext, 53 * TimedAttemptSettings)}, but without a {@link RetryingContext}. 54 * 55 * <p>Use {@link TimedRetryAlgorithmWithContext#createNextAttempt(RetryingContext, 56 * TimedAttemptSettings)} instead of this method when possible. 57 */ createNextAttempt(TimedAttemptSettings prevSettings)58 TimedAttemptSettings createNextAttempt(TimedAttemptSettings prevSettings); 59 60 /** 61 * Same as {@link TimedRetryAlgorithmWithContext#shouldRetry(RetryingContext, 62 * TimedAttemptSettings)}, but without a {@link RetryingContext}. 63 * 64 * <p>Use {@link TimedRetryAlgorithmWithContext#shouldRetry(RetryingContext, 65 * TimedAttemptSettings)} instead of this method when possible. 66 */ shouldRetry(TimedAttemptSettings nextAttemptSettings)67 boolean shouldRetry(TimedAttemptSettings nextAttemptSettings) throws CancellationException; 68 } 69