refactor: sanitize javadoc

This commit is contained in:
Ilkka Seppälä
2024-05-23 18:40:52 +03:00
parent 7273c242b6
commit 8389456532
204 changed files with 127 additions and 337 deletions
@@ -54,7 +54,6 @@ import org.slf4j.LoggerFactory;
* <p>To keep the calling code as decoupled as possible from this workaround, we have implemented
* the retry mechanism as a {@link BusinessOperation} named {@link Retry}.
*
* @author George Aristy (george.aristy@gmail.com)
* @see <a href="https://docs.microsoft.com/en-us/azure/architecture/patterns/retry">Retry pattern
* (Microsoft Azure Docs)</a>
*/
@@ -32,7 +32,6 @@ import java.io.Serial;
* specificity of the error condition in question. Calling code is not expected to be able to handle
* this error and should be reported to the maintainers immediately.
*
* @author George Aristy (george.aristy@gmail.com)
*/
public class BusinessException extends Exception {
@Serial
@@ -28,7 +28,6 @@ package com.iluwatar.retry;
* Performs some business operation.
*
* @param <T> the return type
* @author George Aristy (george.aristy@gmail.com)
*/
@FunctionalInterface
public interface BusinessOperation<T> {
@@ -33,7 +33,6 @@ import java.io.Serial;
* triggered by an input from some end user, or were the search parameters pulled from your
* database?
*
* @author George Aristy (george.aristy@gmail.com)
*/
public final class CustomerNotFoundException extends BusinessException {
@@ -29,7 +29,6 @@ import java.io.Serial;
/**
* Catastrophic error indicating that we have lost connection to our database.
*
* @author George Aristy (george.aristy@gmail.com)
*/
public final class DatabaseNotAvailableException extends BusinessException {
@Serial
@@ -35,7 +35,6 @@ import java.util.List;
* However, this is a "flaky" operation that is supposed to fail intermittently, but for the
* purposes of this example it fails in a programmed way depending on the constructor parameters.
*
* @author George Aristy (george.aristy@gmail.com)
*/
public record FindCustomer(String customerId, Deque<BusinessException> errors) implements BusinessOperation<String> {
@@ -35,7 +35,6 @@ import java.util.function.Predicate;
* Decorates {@link BusinessOperation business operation} with "retry" capabilities.
*
* @param <T> the remote op's return type
* @author George Aristy (george.aristy@gmail.com)
*/
public final class Retry<T> implements BusinessOperation<T> {
private final BusinessOperation<T> op;
@@ -36,7 +36,6 @@ import java.util.function.Predicate;
* Decorates {@link BusinessOperation business operation} with "retry" capabilities.
*
* @param <T> the remote op's return type
* @author George Aristy (george.aristy@gmail.com)
*/
public final class RetryExponentialBackoff<T> implements BusinessOperation<T> {
private static final Random RANDOM = new Random();
@@ -33,7 +33,6 @@ import org.junit.jupiter.api.Test;
/**
* Unit tests for {@link FindCustomer}.
*
* @author George Aristy (george.aristy@gmail.com)
*/
class FindCustomerTest {
/**
@@ -33,7 +33,6 @@ import org.junit.jupiter.api.Test;
/**
* Unit tests for {@link Retry}.
*
* @author George Aristy (george.aristy@gmail.com)
*/
class RetryExponentialBackoffTest {
/**
@@ -33,7 +33,6 @@ import org.junit.jupiter.api.Test;
/**
* Unit tests for {@link Retry}.
*
* @author George Aristy (george.aristy@gmail.com)
*/
class RetryTest {