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 2022/04/03 21:31:28 UTC
[commons-lang] 05/05: No need to use the java.lang package name in Javadoc references.
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
commit eb62fccc1cbedd7f27c817593cbd7708828627c4
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Apr 3 17:19:06 2022 -0400
No need to use the java.lang package name in Javadoc references.
---
.../org/apache/commons/lang3/ClassPathUtils.java | 8 ++++----
.../java/org/apache/commons/lang3/StringUtils.java | 2 +-
.../commons/lang3/time/DurationFormatUtils.java | 16 ++++++++--------
.../AbstractConcurrentInitializerTest.java | 2 +-
.../lang3/concurrent/AtomicSafeInitializerTest.java | 2 +-
.../lang3/concurrent/BackgroundInitializerTest.java | 2 +-
.../CallableBackgroundInitializerTest.java | 2 +-
.../lang3/concurrent/ConcurrentUtilsTest.java | 4 ++--
.../commons/lang3/concurrent/TimedSemaphoreTest.java | 20 ++++++++++----------
.../org/apache/commons/lang3/time/DateUtilsTest.java | 10 +++++-----
10 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/ClassPathUtils.java b/src/main/java/org/apache/commons/lang3/ClassPathUtils.java
index 3e1adda9a..bd58e78ab 100644
--- a/src/main/java/org/apache/commons/lang3/ClassPathUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ClassPathUtils.java
@@ -51,7 +51,7 @@ public class ClassPathUtils {
* @param context The context for constructing the name.
* @param resourceName the resource name to construct the fully qualified name for.
* @return the fully qualified name of the resource with name {@code resourceName}.
- * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
+ * @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedName(final Class<?> context, final String resourceName) {
Validate.notNull(context, "context" );
@@ -73,7 +73,7 @@ public class ClassPathUtils {
* @param context The context for constructing the name.
* @param resourceName the resource name to construct the fully qualified name for.
* @return the fully qualified name of the resource with name {@code resourceName}.
- * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
+ * @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedName(final Package context, final String resourceName) {
Validate.notNull(context, "context" );
@@ -95,7 +95,7 @@ public class ClassPathUtils {
* @param context The context for constructing the path.
* @param resourceName the resource name to construct the fully qualified path for.
* @return the fully qualified path of the resource with name {@code resourceName}.
- * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
+ * @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedPath(final Class<?> context, final String resourceName) {
Validate.notNull(context, "context" );
@@ -118,7 +118,7 @@ public class ClassPathUtils {
* @param context The context for constructing the path.
* @param resourceName the resource name to construct the fully qualified path for.
* @return the fully qualified path of the resource with name {@code resourceName}.
- * @throws java.lang.NullPointerException if either {@code context} or {@code resourceName} is null.
+ * @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedPath(final Package context, final String resourceName) {
Validate.notNull(context, "context" );
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java
index 9fcd06053..599801e47 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -4883,7 +4883,7 @@ public class StringUtils {
* @param delimiter the separator character to use, null treated as ""
* @param array the varargs providing the values to join together. {@code null} elements are treated as ""
* @return the joined String.
- * @throws java.lang.IllegalArgumentException if a null varargs is provided
+ * @throws IllegalArgumentException if a null varargs is provided
* @since 3.5
*/
public static String joinWith(final String delimiter, final Object... array) {
diff --git a/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java b/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
index 57c921ef2..11b565b01 100644
--- a/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
@@ -75,7 +75,7 @@ public class DurationFormatUtils {
*
* @param durationMillis the duration to format
* @return the formatted duration, not null
- * @throws java.lang.IllegalArgumentException if durationMillis is negative
+ * @throws IllegalArgumentException if durationMillis is negative
*/
public static String formatDurationHMS(final long durationMillis) {
return formatDuration(durationMillis, "HH:mm:ss.SSS");
@@ -91,7 +91,7 @@ public class DurationFormatUtils {
*
* @param durationMillis the duration to format
* @return the formatted duration, not null
- * @throws java.lang.IllegalArgumentException if durationMillis is negative
+ * @throws IllegalArgumentException if durationMillis is negative
*/
public static String formatDurationISO(final long durationMillis) {
return formatDuration(durationMillis, ISO_EXTENDED_FORMAT_PATTERN, false);
@@ -106,7 +106,7 @@ public class DurationFormatUtils {
* @param durationMillis the duration to format
* @param format the way in which to format the duration, not null
* @return the formatted duration, not null
- * @throws java.lang.IllegalArgumentException if durationMillis is negative
+ * @throws IllegalArgumentException if durationMillis is negative
*/
public static String formatDuration(final long durationMillis, final String format) {
return formatDuration(durationMillis, format, true);
@@ -123,7 +123,7 @@ public class DurationFormatUtils {
* @param format the way in which to format the duration, not null
* @param padWithZeros whether to pad the left hand side of numbers with 0's
* @return the formatted duration, not null
- * @throws java.lang.IllegalArgumentException if durationMillis is negative
+ * @throws IllegalArgumentException if durationMillis is negative
*/
public static String formatDuration(final long durationMillis, final String format, final boolean padWithZeros) {
Validate.inclusiveBetween(0, Long.MAX_VALUE, durationMillis, "durationMillis must not be negative");
@@ -166,7 +166,7 @@ public class DurationFormatUtils {
* @param suppressLeadingZeroElements suppresses leading 0 elements
* @param suppressTrailingZeroElements suppresses trailing 0 elements
* @return the formatted text in days/hours/minutes/seconds, not null
- * @throws java.lang.IllegalArgumentException if durationMillis is negative
+ * @throws IllegalArgumentException if durationMillis is negative
*/
public static String formatDurationWords(
final long durationMillis,
@@ -229,7 +229,7 @@ public class DurationFormatUtils {
* @param startMillis the start of the duration to format
* @param endMillis the end of the duration to format
* @return the formatted duration, not null
- * @throws java.lang.IllegalArgumentException if startMillis is greater than endMillis
+ * @throws IllegalArgumentException if startMillis is greater than endMillis
*/
public static String formatPeriodISO(final long startMillis, final long endMillis) {
return formatPeriod(startMillis, endMillis, ISO_EXTENDED_FORMAT_PATTERN, false, TimeZone.getDefault());
@@ -243,7 +243,7 @@ public class DurationFormatUtils {
* @param endMillis the end of the duration
* @param format the way in which to format the duration, not null
* @return the formatted duration, not null
- * @throws java.lang.IllegalArgumentException if startMillis is greater than endMillis
+ * @throws IllegalArgumentException if startMillis is greater than endMillis
*/
public static String formatPeriod(final long startMillis, final long endMillis, final String format) {
return formatPeriod(startMillis, endMillis, format, true, TimeZone.getDefault());
@@ -271,7 +271,7 @@ public class DurationFormatUtils {
* @param padWithZeros whether to pad the left hand side of numbers with 0's
* @param timezone the millis are defined in
* @return the formatted duration, not null
- * @throws java.lang.IllegalArgumentException if startMillis is greater than endMillis
+ * @throws IllegalArgumentException if startMillis is greater than endMillis
*/
public static String formatPeriod(final long startMillis, final long endMillis, final String format, final boolean padWithZeros,
final TimeZone timezone) {
diff --git a/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java
index c88f29e0b..bc6eddbc3 100644
--- a/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java
+++ b/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java
@@ -65,7 +65,7 @@ public abstract class AbstractConcurrentInitializerTest {
* Always the same object should be returned.
*
* @throws org.apache.commons.lang3.concurrent.ConcurrentException because the object under test may throw it.
- * @throws java.lang.InterruptedException because the threading API my throw it.
+ * @throws InterruptedException because the threading API my throw it.
*/
@Test
public void testGetConcurrent() throws ConcurrentException,
diff --git a/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java
index a1f6194c0..3352f99dd 100644
--- a/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java
+++ b/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java
@@ -50,7 +50,7 @@ public class AtomicSafeInitializerTest extends AbstractConcurrentInitializerTest
* Tests that initialize() is called only once.
*
* @throws org.apache.commons.lang3.concurrent.ConcurrentException because {@link #testGetConcurrent()} may throw it
- * @throws java.lang.InterruptedException because {@link #testGetConcurrent()} may throw it
+ * @throws InterruptedException because {@link #testGetConcurrent()} may throw it
*/
@Test
public void testNumberOfInitializeInvocations() throws ConcurrentException, InterruptedException {
diff --git a/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java
index 70d5358a4..77fd6eee2 100644
--- a/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java
+++ b/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java
@@ -202,7 +202,7 @@ public class BackgroundInitializerTest {
/**
* Tests the get() method if waiting for the initialization is interrupted.
*
- * @throws java.lang.InterruptedException because we're making use of Java's concurrent API
+ * @throws InterruptedException because we're making use of Java's concurrent API
*/
@Test
public void testGetInterruptedException() throws InterruptedException {
diff --git a/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java
index 61746cc27..659a76173 100644
--- a/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java
+++ b/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java
@@ -75,7 +75,7 @@ public class CallableBackgroundInitializerTest {
/**
* Tests the implementation of initialize().
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testInitialize() throws Exception {
diff --git a/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java b/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java
index 218d61c3d..e7b8752e5 100644
--- a/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java
+++ b/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java
@@ -334,7 +334,7 @@ public class ConcurrentUtilsTest {
/**
* Tests constant future.
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testConstantFuture_Integer() throws Exception {
@@ -352,7 +352,7 @@ public class ConcurrentUtilsTest {
/**
* Tests constant future.
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testConstantFuture_null() throws Exception {
diff --git a/src/test/java/org/apache/commons/lang3/concurrent/TimedSemaphoreTest.java b/src/test/java/org/apache/commons/lang3/concurrent/TimedSemaphoreTest.java
index aa550872e..45d0db5ac 100644
--- a/src/test/java/org/apache/commons/lang3/concurrent/TimedSemaphoreTest.java
+++ b/src/test/java/org/apache/commons/lang3/concurrent/TimedSemaphoreTest.java
@@ -92,7 +92,7 @@ public class TimedSemaphoreTest {
/**
* Tests starting the timer.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testStartTimer() throws InterruptedException {
@@ -155,7 +155,7 @@ public class TimedSemaphoreTest {
* Tests the shutdown() method for a shared executor after the task was
* started. In this case the task must be canceled.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testShutdownSharedExecutorTask() throws InterruptedException {
@@ -176,7 +176,7 @@ public class TimedSemaphoreTest {
/**
* Tests multiple invocations of the shutdown() method.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testShutdownMultipleTimes() throws InterruptedException {
@@ -198,7 +198,7 @@ public class TimedSemaphoreTest {
/**
* Tests the acquire() method if a limit is set.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testAcquireLimit() throws InterruptedException {
@@ -234,7 +234,7 @@ public class TimedSemaphoreTest {
* semaphore's limit is set to 1, so in each period only a single thread can
* acquire the semaphore.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testAcquireMultipleThreads() throws InterruptedException {
@@ -270,7 +270,7 @@ public class TimedSemaphoreTest {
* that calls the semaphore a large number of times. Even if the semaphore's
* period does not end, the thread should never block.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testAcquireNoLimit() throws InterruptedException {
@@ -305,7 +305,7 @@ public class TimedSemaphoreTest {
* semaphore a large number of times. While it runs at last one end of a
* period should be reached.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testAcquireMultiplePeriods() throws InterruptedException {
@@ -324,7 +324,7 @@ public class TimedSemaphoreTest {
/**
* Tests the methods for statistics.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testGetAverageCallsPerPeriod() throws InterruptedException {
@@ -348,7 +348,7 @@ public class TimedSemaphoreTest {
/**
* Tests whether the available non-blocking calls can be queried.
*
- * @throws java.lang.InterruptedException so we don't have to catch it
+ * @throws InterruptedException so we don't have to catch it
*/
@Test
public void testGetAvailablePermits() throws InterruptedException {
@@ -442,7 +442,7 @@ public class TimedSemaphoreTest {
/**
* Invokes the latch if one is set.
*
- * @throws java.lang.InterruptedException because it is declared that way in TimedSemaphore
+ * @throws InterruptedException because it is declared that way in TimedSemaphore
*/
@Override
public synchronized void acquire() throws InterruptedException {
diff --git a/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java
index bd82335d2..9a6464934 100644
--- a/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java
+++ b/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java
@@ -377,7 +377,7 @@ public class DateUtilsTest {
/**
* Tests various values with the ceiling method
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testCeil() throws Exception {
@@ -833,7 +833,7 @@ public class DateUtilsTest {
/**
* Tests the calendar iterator for month-based ranges
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testMonthIterator() throws Exception {
@@ -919,7 +919,7 @@ public class DateUtilsTest {
/**
* Tests various values with the round method
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testRound() throws Exception {
@@ -1129,7 +1129,7 @@ public class DateUtilsTest {
* Tests the Changes Made by LANG-346 to the DateUtils.modify() private method invoked
* by DateUtils.round().
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testRoundLang346() throws Exception {
@@ -1401,7 +1401,7 @@ public class DateUtilsTest {
/**
* Tests various values with the trunc method
*
- * @throws java.lang.Exception so we don't have to catch it
+ * @throws Exception so we don't have to catch it
*/
@Test
public void testTruncate() throws Exception {