001/* 002 * Copyright 2002-2016 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.util.backoff; 018 019/** 020 * Represent a particular back-off execution. 021 * 022 * <p>Implementations do not need to be thread safe. 023 * 024 * @author Stephane Nicoll 025 * @since 4.1 026 * @see BackOff 027 */ 028@FunctionalInterface 029public interface BackOffExecution { 030 031 /** 032 * Return value of {@link #nextBackOff()} that indicates that the operation 033 * should not be retried. 034 */ 035 long STOP = -1; 036 037 /** 038 * Return the number of milliseconds to wait before retrying the operation 039 * or {@link #STOP} ({@value #STOP}) to indicate that no further attempt 040 * should be made for the operation. 041 */ 042 long nextBackOff(); 043 044}