From 528f6e8e705097d5237f3e29d64c37ade4092e18 Mon Sep 17 00:00:00 2001
From: pascalschumacher
Date: Wed, 8 Jun 2016 22:15:13 +0200
Subject: [PATCH] LANG-1085: Add a circuit breaker implementation
add since javadoc tags
fix javadoc warning
---
.../commons/lang3/concurrent/AbstractCircuitBreaker.java | 3 ++-
.../org/apache/commons/lang3/concurrent/CircuitBreaker.java | 1 +
.../commons/lang3/concurrent/CircuitBreakingException.java | 1 +
.../commons/lang3/concurrent/EventCountCircuitBreaker.java | 1 +
.../commons/lang3/concurrent/ThresholdCircuitBreaker.java | 1 +
5 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
index 6df864253..dfe365167 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
@@ -24,6 +24,7 @@
* Base class for circuit breakers.
*
* @param the type of the value monitored by this circuit breaker
+ * @since 3.5
*/
public abstract class AbstractCircuitBreaker implements CircuitBreaker {
/**
@@ -39,7 +40,7 @@ public abstract class AbstractCircuitBreaker implements CircuitBreaker {
private final PropertyChangeSupport changeSupport;
/**
- * Creates an {@AbstractCircuitBreaker}. It also creates an internal {@code PropertyChangeSupport}.
+ * Creates an {@code AbstractCircuitBreaker}. It also creates an internal {@code PropertyChangeSupport}.
*/
public AbstractCircuitBreaker() {
changeSupport = new PropertyChangeSupport(this);
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
index 780af468d..7420e70cd 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
@@ -37,6 +37,7 @@
*
*
* @param the type of the value monitored by this circuit breaker
+ * @since 3.5
*/
public interface CircuitBreaker {
/**
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java
index e6cbdf784..5a3728373 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java
@@ -21,6 +21,7 @@
* An exception class used for reporting runtime error conditions related to
* circuit breakers.
*
+ * @since 3.5
*/
public class CircuitBreakingException extends RuntimeException {
/**
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java b/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
index 312c3b4eb..c5539352a 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
@@ -133,6 +133,7 @@
* guarantee that the circuit breaker is triggered at a specific point in time; there may
* be some delay (less than a check interval).
*
+ * @since 3.5
*/
public class EventCountCircuitBreaker extends AbstractCircuitBreaker {
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java b/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
index 06b715214..b225d2bfc 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
@@ -49,6 +49,7 @@
*
*
* #Thread safe#
+ * @since 3.5
*/
public class ThresholdCircuitBreaker extends AbstractCircuitBreaker {
/**