This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new d05ad7a Add missing Javadoc.
d05ad7a is described below
commit d05ad7abd6093f26e79c15e585c77c7102c3a9df
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Oct 20 10:47:07 2020 -0400
Add missing Javadoc.
---
.../lang3/concurrent/AbstractCircuitBreaker.java | 4 ++++
.../java/org/apache/commons/lang3/stream/Streams.java | 10 ++++++++++
.../lang3/text/translate/NumericEntityUnescaper.java | 17 ++++++++++++++++-
3 files changed, 30 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 0107924..05c1cc9 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
@@ -27,6 +27,7 @@ import java.util.concurrent.atomic.AtomicReference;
* @since 3.5
*/
public abstract class AbstractCircuitBreaker<T> implements CircuitBreaker<T> {
+
/**
* The name of the <em>open</em> property as it is passed to registered
* change listeners.
@@ -139,6 +140,8 @@ public abstract class AbstractCircuitBreaker<T> implements
CircuitBreaker<T> {
* {@code CircuitBreaker}.
*/
protected enum State {
+
+ /** The closed state. */
CLOSED {
/**
* {@inheritDoc}
@@ -149,6 +152,7 @@ public abstract class AbstractCircuitBreaker<T> implements
CircuitBreaker<T> {
}
},
+ /** The open state. */
OPEN {
/**
* {@inheritDoc}
diff --git a/src/main/java/org/apache/commons/lang3/stream/Streams.java
b/src/main/java/org/apache/commons/lang3/stream/Streams.java
index ff4da1a..9dd75e9 100644
--- a/src/main/java/org/apache/commons/lang3/stream/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/stream/Streams.java
@@ -66,10 +66,20 @@ import org.apache.commons.lang3.function.FailablePredicate;
*/
public class Streams {
+ /**
+ * A Collector type for arrays.
+ *
+ * @param <O> The array type.
+ */
public static class ArrayCollector<O> implements Collector<O, List<O>,
O[]> {
private static final Set<Characteristics> characteristics =
Collections.emptySet();
private final Class<O> elementType;
+ /**
+ * Constructs a new instance for the given element type.
+ *
+ * @param elementType The element type.
+ */
public ArrayCollector(final Class<O> elementType) {
this.elementType = elementType;
}
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
b/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
index e765825..670fb07 100644
---
a/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
+++
b/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
@@ -36,8 +36,23 @@ import java.util.EnumSet;
@Deprecated
public class NumericEntityUnescaper extends CharSequenceTranslator {
+ /** Enumerates NumericEntityUnescaper options for unescaping. */
public enum OPTION {
- semiColonRequired, semiColonOptional, errorIfNoSemiColon
+
+ /**
+ * Require a semicolon.
+ */
+ semiColonRequired,
+
+ /**
+ * Do not require a semicolon.
+ */
+ semiColonOptional,
+
+ /**
+ * Throw an exception if a semi-colon is missing.
+ */
+ errorIfNoSemiColon
}
// TODO?: Create an OptionsSet class to hide some of the conditional logic
below
