/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.retry;

import edu.umd.cs.findbugs.annotations.Nullable;
import java.time.Duration;
import java.util.Optional;
import java.util.OptionalDouble;

An interface that encapsulates the current state of a Retryable operation. 
Author:
graemerocher
Since:
1.0/**
 * An interface that encapsulates the current state of a {@link io.micronaut.retry.annotation.Retryable} operation.
 *
 * @author graemerocher
 * @since 1.0
 */
public interface RetryState {

    
Should a retry attempt occur.
Params:
exception – The error
Returns:
True if it should/**
     * Should a retry attempt occur.
     *
     * @param exception The error
     *
     * @return True if it should
     */
    boolean canRetry(Throwable exception);

    
Returns:
The maximum number of attempts/**
     * @return The maximum number of attempts
     */
    int getMaxAttempts();

    
Returns:
The number of the current attempt/**
     * @return The number of the current attempt
     */
    int currentAttempt();

    
Returns:
The multiplier to use between delays/**
     * @return The multiplier to use between delays
     */
    OptionalDouble getMultiplier();

    
Returns:
The delay between attempts/**
     * @return The delay between attempts
     */
    Duration getDelay();

    
Returns:
The overall delay so far/**
     * @return The overall delay so far
     */
    Duration getOverallDelay();

    
Returns:
The maximum overall delay/**
     * @return The maximum overall delay
     */
    Optional<Duration> getMaxDelay();

    
Opens the retry state.
/**
     * Opens the retry state.
     */
    default void open() {
        // no-op for stateless retry
    }

    
Closes the RetryState. 
Params:
exception – An exception if an error occurred or null if the operation completed as expected/**
     * Closes the {@link RetryState}.
     *
     * @param exception An exception if an error occurred or null if the operation completed as expected
     */
    default void close(@Nullable Throwable exception) {
        // no-op for stateless retry
    }
}