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 dc798e6f5..4df62ece1 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java @@ -39,21 +39,22 @@ package org.apache.commons.lang3.concurrent; * @since 3.5 */ public interface CircuitBreaker { + /** - * Returns the current open state of this circuit breaker. A return value of + * Tests the current open state of this circuit breaker. A return value of * true means that the circuit breaker is currently open indicating a * problem in the monitored sub system. * - * @return the current open state of this circuit breaker + * @return the current open state of this circuit breaker. */ boolean isOpen(); /** - * Returns the current closed state of this circuit breaker. A return value of + * Tests the current closed state of this circuit breaker. A return value of * true means that the circuit breaker is currently closed. This * means that everything is okay with the monitored sub system. * - * @return the current closed state of this circuit breaker + * @return the current closed state of this circuit breaker. */ boolean isClosed(); @@ -63,7 +64,7 @@ public interface CircuitBreaker { * of true typically means that the current operation can continue. * * @return true if the circuit breaker is now closed; - * false otherwise + * false otherwise. */ boolean checkState();