Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add details to the ArraySorter Javadoc

This commit is contained in:
Gary Gregory 2024-10-13 09:26:32 -04:00
parent eee98089ac
commit d540452cc5
2 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -56,6 +56,7 @@ The <action> type attribute can be add,update,fix,remove.
<action type="fix" dev="ggregory" due-to="Gary Gregory">Remove trailing whitespace in StopWatch exception messages.</action> <action type="fix" dev="ggregory" due-to="Gary Gregory">Remove trailing whitespace in StopWatch exception messages.</action>
<action issue="LANG-1754" type="fix" dev="ggregory" due-to="vhbcm">Use getAllSuperclassesAndInterfaces() in getMatchingMethod() #1289.</action> <action issue="LANG-1754" type="fix" dev="ggregory" due-to="vhbcm">Use getAllSuperclassesAndInterfaces() in getMatchingMethod() #1289.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory">Add details to the ArrayFill Javadoc.</action> <action type="fix" dev="ggregory" due-to="Gary Gregory">Add details to the ArrayFill Javadoc.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory">Add details to the ArraySorter Javadoc.</action>
<!-- ADD --> <!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary Gregory">Add Strings and refactor StringUtils.</action> <action type="add" dev="ggregory" due-to="Gary Gregory">Add Strings and refactor StringUtils.</action>
<action issue="LANG-1747" type="add" dev="ggregory" due-to="Oliver B. Fischer, Gary Gregory">Add StopWatch.run([Failable]Runnable) and get([Failable]Supplier).</action> <action issue="LANG-1747" type="add" dev="ggregory" due-to="Oliver B. Fischer, Gary Gregory">Add StopWatch.run([Failable]Runnable) and get([Failable]Supplier).</action>

36
src/main/java/org/apache/commons/lang3/ArraySorter.java
View File

@ -28,9 +28,9 @@ import java.util.Comparator;
public class ArraySorter { public class ArraySorter {
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(byte[]) * @see Arrays#sort(byte[])
*/ */
@ -42,9 +42,9 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(char[]) * @see Arrays#sort(char[])
*/ */
@ -56,9 +56,9 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(double[]) * @see Arrays#sort(double[])
*/ */
@ -70,9 +70,9 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(float[]) * @see Arrays#sort(float[])
*/ */
@ -84,9 +84,9 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(int[]) * @see Arrays#sort(int[])
*/ */
@ -98,9 +98,9 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(long[]) * @see Arrays#sort(long[])
*/ */
@ -112,9 +112,9 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(short[]) * @see Arrays#sort(short[])
*/ */
@ -126,10 +126,10 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param <T> the array type. * @param <T> the array type.
* @param array the array to sort. * @param array the array to sort (may be null).
* @return the given array. * @return the given array.
* @see Arrays#sort(Object[]) * @see Arrays#sort(Object[])
*/ */
@ -141,10 +141,10 @@ public class ArraySorter {
} }
/** /**
* Sorts and returns the given array. * Sorts the given array into ascending order and returns it.
* *
* @param <T> the array type. * @param <T> the array type.
* @param array the array to sort. * @param array the array to sort (may be null).
* @param comparator the comparator to determine the order of the array. A {@code null} value uses the elements' * @param comparator the comparator to determine the order of the array. A {@code null} value uses the elements'
* {@link Comparable natural ordering}. * {@link Comparable natural ordering}.
* @return the given array. * @return the given array.