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

Better JavaDoc for ArrayUtils.shift variants

This commit is contained in:
Benedikt Ritter 2016-09-11 15:22:14 +02:00
parent ff8fd9578e
commit 0bdeb204c8
1 changed files with 70 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
src/main/java/org/apache/commons/lang3/ArrayUtils.java
View File

@ -2486,11 +2486,10 @@ public static void swap(final short[] array, int offset1, int offset2, int len)
// Shift
//-----------------------------------------------------------------------
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given array.
*
* <p>There is no special handling for multi-dimensional arrays.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2506,9 +2505,10 @@ public static void shift(final Object[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given long array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2524,9 +2524,10 @@ public static void shift(final long[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given int array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2542,9 +2543,10 @@ public static void shift(final int[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given short array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2560,9 +2562,10 @@ public static void shift(final short[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given char array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2578,9 +2581,10 @@ public static void shift(final char[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given byte array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2596,9 +2600,10 @@ public static void shift(final byte[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given double array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2614,9 +2619,10 @@ public static void shift(final double[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given float array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2632,9 +2638,10 @@ public static void shift(final float[] array, int offset) {
}
/**
* <p>Shifts the order of the given array.
* Shifts the order of the given boolean array.
*
* <p>This method does nothing for a {@code null} input array.
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array the array to shift, may be {@code null}
* @param offset
@ -2650,11 +2657,10 @@ public static void shift(final boolean[] array, int offset) {
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
* Shifts the order of a series of elements in the given boolean array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
@ -2711,11 +2717,10 @@ public static void shift(final boolean[] array, int startIndexInclusive, int end
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
* Shifts the order of a series of elements in the given byte array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
@ -2772,12 +2777,11 @@ public static void shift(final byte[] array, int startIndexInclusive, int endInd
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
*
* Shifts the order of a series of elements in the given char array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
* @param startIndexInclusive
@ -2833,12 +2837,11 @@ public static void shift(final char[] array, int startIndexInclusive, int endInd
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
*
* Shifts the order of a series of elements in the given double array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
* @param startIndexInclusive
@ -2894,12 +2897,11 @@ public static void shift(final double[] array, int startIndexInclusive, int endI
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
*
* Shifts the order of a series of elements in the given float array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
* @param startIndexInclusive
@ -2955,12 +2957,11 @@ public static void shift(final float[] array, int startIndexInclusive, int endIn
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
*
* Shifts the order of a series of elements in the given int array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
* @param startIndexInclusive
@ -3016,12 +3017,11 @@ public static void shift(final int[] array, int startIndexInclusive, int endInde
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
*
* Shifts the order of a series of elements in the given long array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
* @param startIndexInclusive
@ -3077,12 +3077,11 @@ public static void shift(final long[] array, int startIndexInclusive, int endInd
}
/**
* <p>
* Shifts the order of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
*
* Shifts the order of a series of elements in the given array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
* @param startIndexInclusive
@ -3138,12 +3137,11 @@ public static void shift(final Object[] array, int startIndexInclusive, int endI
}
/**
* <p>
* Rotate the elements of the given array in the given range.
*
* <p>
* This method does nothing for a {@code null} input array.
*
* Shifts the order of a series of elements in the given short array.
*
* <p>There is no special handling for multi-dimensional arrays. This method
* does nothing for {@code null} or empty input arrays.</p>
*
* @param array
* the array to shift, may be {@code null}
* @param startIndexInclusive