You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2020/02/14 15:00:37 UTC
[commons-lang] branch master updated: Javadoc style.
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 d54c895 Javadoc style.
d54c895 is described below
commit d54c8951d64bfaa7b85dc45dda5406ed05f9b07f
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Feb 14 10:00:33 2020 -0500
Javadoc style.
---
.../java/org/apache/commons/lang3/CharRange.java | 8 ++++----
.../java/org/apache/commons/lang3/ThreadUtils.java | 20 ++++++++++----------
.../commons/lang3/builder/HashCodeBuilder.java | 2 +-
.../lang3/concurrent/AtomicSafeInitializer.java | 2 +-
.../commons/lang3/event/EventListenerSupport.java | 2 +-
.../apache/commons/lang3/reflect/MethodUtils.java | 2 +-
.../org/apache/commons/lang3/reflect/TypeUtils.java | 6 +++---
.../commons/lang3/text/ExtendedMessageFormat.java | 2 +-
.../apache/commons/lang3/text/FormattableUtils.java | 2 +-
.../org/apache/commons/lang3/time/DateUtils.java | 2 +-
.../apache/commons/lang3/time/FastDateParser.java | 16 ++++++++--------
11 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/CharRange.java b/src/main/java/org/apache/commons/lang3/CharRange.java
index 6a416bb..be656d2 100644
--- a/src/main/java/org/apache/commons/lang3/CharRange.java
+++ b/src/main/java/org/apache/commons/lang3/CharRange.java
@@ -271,7 +271,7 @@ final class CharRange implements Iterable<Character>, Serializable {
private boolean hasNext;
/**
- * Construct a new iterator for the character range.
+ * Constructs a new iterator for the character range.
*
* @param r The character range
*/
@@ -296,7 +296,7 @@ final class CharRange implements Iterable<Character>, Serializable {
}
/**
- * Prepare the next character in the range.
+ * Prepares the next character in the range.
*/
private void prepareNext() {
if (range.negated) {
@@ -329,7 +329,7 @@ final class CharRange implements Iterable<Character>, Serializable {
}
/**
- * Return the next character in the iteration
+ * Returns the next character in the iteration
*
* @return {@code Character} for the next character
*/
@@ -346,7 +346,7 @@ final class CharRange implements Iterable<Character>, Serializable {
/**
* Always throws UnsupportedOperationException.
*
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException Always thrown.
* @see java.util.Iterator#remove()
*/
@Override
diff --git a/src/main/java/org/apache/commons/lang3/ThreadUtils.java b/src/main/java/org/apache/commons/lang3/ThreadUtils.java
index 16986e0..5534194 100644
--- a/src/main/java/org/apache/commons/lang3/ThreadUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ThreadUtils.java
@@ -36,7 +36,7 @@ import java.util.List;
public class ThreadUtils {
/**
- * Return the active thread with the specified id if it belongs to the specified thread group.
+ * Finds the active thread with the specified id if it belongs to the specified thread group.
*
* @param threadId The thread id
* @param threadGroup The thread group
@@ -59,7 +59,7 @@ public class ThreadUtils {
}
/**
- * Return the active thread with the specified id if it belongs to a thread group with the specified group name.
+ * Finds the active thread with the specified id if it belongs to a thread group with the specified group name.
*
* @param threadId The thread id
* @param threadGroupName The thread group name
@@ -82,7 +82,7 @@ public class ThreadUtils {
}
/**
- * Return active threads with the specified name if they belong to a specified thread group.
+ * Finds active threads with the specified name if they belong to a specified thread group.
*
* @param threadName The thread name
* @param threadGroup The thread group
@@ -100,7 +100,7 @@ public class ThreadUtils {
}
/**
- * Return active threads with the specified name if they belong to a thread group with the specified group name.
+ * Finds active threads with the specified name if they belong to a thread group with the specified group name.
*
* @param threadName The thread name
* @param threadGroupName The thread group name
@@ -132,7 +132,7 @@ public class ThreadUtils {
}
/**
- * Return active thread groups with the specified group name.
+ * Finds active thread groups with the specified group name.
*
* @param threadGroupName The thread group name
* @return the thread groups with the specified group name or an empty collection if no such thread group exists. The collection returned is always unmodifiable.
@@ -148,7 +148,7 @@ public class ThreadUtils {
}
/**
- * Return all active thread groups excluding the system thread group (A thread group is active if it has been not destroyed).
+ * Gets all active thread groups excluding the system thread group (A thread group is active if it has been not destroyed).
*
* @return all thread groups excluding the system thread group. The collection returned is always unmodifiable.
* @throws SecurityException
@@ -162,7 +162,7 @@ public class ThreadUtils {
}
/**
- * Return the system thread group (sometimes also referred as "root thread group").
+ * Gets the system thread group (sometimes also referred as "root thread group").
*
* @return the system thread group
* @throws SecurityException if the current thread cannot modify
@@ -177,7 +177,7 @@ public class ThreadUtils {
}
/**
- * Return all active threads (A thread is active if it has been started and has not yet died).
+ * Gets all active threads (A thread is active if it has been started and has not yet died).
*
* @return all active threads. The collection returned is always unmodifiable.
* @throws SecurityException
@@ -191,7 +191,7 @@ public class ThreadUtils {
}
/**
- * Return active threads with the specified name.
+ * Finds active threads with the specified name.
*
* @param threadName The thread name
* @return The threads with the specified name or an empty collection if no such thread exists. The collection returned is always unmodifiable.
@@ -207,7 +207,7 @@ public class ThreadUtils {
}
/**
- * Return the active thread with the specified id.
+ * Finds the active thread with the specified id.
*
* @param threadId The thread id
* @return The thread with the specified id or {@code null} if no such thread exists
diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
index 90d4fab..c430b40 100644
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
@@ -959,7 +959,7 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Return the computed {@code hashCode}.
+ * Returns the computed {@code hashCode}.
* </p>
*
* @return {@code hashCode} based on the fields appended
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java b/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
index 0b1a500..5bc91f1 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
@@ -62,7 +62,7 @@ public abstract class AtomicSafeInitializer<T> implements
private final AtomicReference<T> reference = new AtomicReference<>();
/**
- * Get (and initialize, if not initialized yet) the required object
+ * Gets (and initialize, if not initialized yet) the required object
*
* @return lazily initialized object
* @throws ConcurrentException if the initialization of the object causes an
diff --git a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
index 1813375..499032d 100644
--- a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
+++ b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
@@ -225,7 +225,7 @@ public class EventListenerSupport<L> implements Serializable {
}
/**
- * Get an array containing the currently registered listeners.
+ * Gets an array containing the currently registered listeners.
* Modification to this array's elements will have no effect on the
* {@link EventListenerSupport} instance.
* @return L[]
diff --git a/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java b/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java
index 905052f..8ebc790 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java
@@ -785,7 +785,7 @@ public class MethodUtils {
}
/**
- * Get the hierarchy of overridden methods down to {@code result} respecting generics.
+ * Gets the hierarchy of overridden methods down to {@code result} respecting generics.
* @param method lowest to consider
* @param interfacesBehavior whether to search interfaces, {@code null} {@code implies} false
* @return Set<Method> in ascending order from sub- to superclass
diff --git a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java
index e1bbd0e..eced4e0 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java
@@ -1338,7 +1338,7 @@ public class TypeUtils {
}
/**
- * Get the array component type of {@code type}.
+ * Gets the array component type of {@code type}.
* @param type the type to be checked
* @return component type or null if type is not an array type
*/
@@ -1354,7 +1354,7 @@ public class TypeUtils {
}
/**
- * Get a type representing {@code type} with variable assignments "unrolled."
+ * Gets a type representing {@code type} with variable assignments "unrolled."
*
* @param typeArguments as from {@link TypeUtils#getTypeArguments(Type, Class)}
* @param type the type to unroll variable assignments for
@@ -1540,7 +1540,7 @@ public class TypeUtils {
}
/**
- * Get a {@link WildcardTypeBuilder}.
+ * Gets a {@link WildcardTypeBuilder}.
* @return {@link WildcardTypeBuilder}
* @since 3.2
*/
diff --git a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
index f52097b..6b921b8 100644
--- a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
@@ -295,7 +295,7 @@ public class ExtendedMessageFormat extends MessageFormat {
}
/**
- * Get a custom format from a format description.
+ * Gets a custom format from a format description.
*
* @param desc String
* @return Format
diff --git a/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java b/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java
index dd95561..a98299c 100644
--- a/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java
+++ b/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java
@@ -59,7 +59,7 @@ public class FormattableUtils {
//-----------------------------------------------------------------------
/**
- * Get the default formatted representation of the specified
+ * Gets the default formatted representation of the specified
* {@code Formattable}.
*
* @param formattable the instance to convert to a string, not null
diff --git a/src/main/java/org/apache/commons/lang3/time/DateUtils.java b/src/main/java/org/apache/commons/lang3/time/DateUtils.java
index 2d651cf..9fa2549 100644
--- a/src/main/java/org/apache/commons/lang3/time/DateUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DateUtils.java
@@ -1821,7 +1821,7 @@ public class DateUtils {
}
/**
- * Return the next calendar in the iteration
+ * Returns the next calendar in the iteration
*
* @return Object calendar for the next date
*/
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
index 79fb37d..233cf3f 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java
@@ -451,7 +451,7 @@ public class FastDateParser implements DateParser, Serializable {
}
/**
- * Get the short and long values displayed for a field
+ * Gets the short and long values displayed for a field
* @param cal The calendar to obtain the short and long values
* @param locale The locale of display names
* @param field The field of interest
@@ -606,7 +606,7 @@ public class FastDateParser implements DateParser, Serializable {
private static final ConcurrentMap<Locale, Strategy>[] caches = new ConcurrentMap[Calendar.FIELD_COUNT];
/**
- * Get a cache of Strategies for a particular field
+ * Gets a cache of Strategies for a particular field
* @param field The Calendar field
* @return a cache of Locale to Strategy
*/
@@ -620,7 +620,7 @@ public class FastDateParser implements DateParser, Serializable {
}
/**
- * Construct a Strategy that parses a Text field
+ * Constructs a Strategy that parses a Text field
* @param field The Calendar field
* @param definingCalendar The calendar to obtain the short and long values
* @return a TextStrategy for the field and Locale
@@ -648,7 +648,7 @@ public class FastDateParser implements DateParser, Serializable {
private final String formatField;
/**
- * Construct a Strategy that ensures the formatField has literal text
+ * Constructs a Strategy that ensures the formatField has literal text
* @param formatField The literal text to match
*/
CopyQuotedStrategy(final String formatField) {
@@ -690,7 +690,7 @@ public class FastDateParser implements DateParser, Serializable {
private final Map<String, Integer> lKeyValues;
/**
- * Construct a Strategy that parses a Text field
+ * Constructs a Strategy that parses a Text field
* @param field The Calendar field
* @param definingCalendar The Calendar to use
* @param locale The Locale to use
@@ -730,7 +730,7 @@ public class FastDateParser implements DateParser, Serializable {
private final int field;
/**
- * Construct a Strategy that parses a Number field
+ * Constructs a Strategy that parses a Number field
* @param field The Calendar field
*/
NumberStrategy(final int field) {
@@ -833,7 +833,7 @@ public class FastDateParser implements DateParser, Serializable {
private static final int ID = 0;
/**
- * Construct a Strategy that parses a TimeZone
+ * Constructs a Strategy that parses a TimeZone
* @param locale The Locale
*/
TimeZoneStrategy(final Locale locale) {
@@ -912,7 +912,7 @@ public class FastDateParser implements DateParser, Serializable {
// Z, +hh, -hh, +hhmm, -hhmm, +hh:mm or -hh:mm
/**
- * Construct a Strategy that parses a TimeZone
+ * Constructs a Strategy that parses a TimeZone
* @param pattern The Pattern
*/
ISO8601TimeZoneStrategy(final String pattern) {