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

Update Javadoc since tags

This commit is contained in:
Gary Gregory 2024-06-23 07:58:54 -04:00
parent 7c32ff7daf
commit 294b820b02
9 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/main/java/org/apache/commons/collections4/CollectionUtils.java
View File

@ -217,34 +217,34 @@ public class CollectionUtils {
/**
* The index value when an element is not found in a collection or array: {@code -1}.
*
* @since 4.5
* @since 4.5.0
*/
public static final int INDEX_NOT_FOUND = -1;
/**
* Default prefix used while converting an Iterator to its String representation.
*
* @since 4.5
* @since 4.5.0
*/
public static final String DEFAULT_TOSTRING_PREFIX = "[";
/**
* Default suffix used while converting an Iterator to its String representation.
*
* @since 4.5
* @since 4.5.0
*/
public static final String DEFAULT_TOSTRING_SUFFIX = "]";
/**
* A String for Colon (":").
*
* @since 4.5
* @since 4.5.0
*/
public static final String COLON = ":";
/**
* A String for Comma (",").
*
* @since 4.5
* @since 4.5.0
*/
public static final String COMMA = ",";
@ -1128,7 +1128,7 @@ public class CollectionUtils {
* @param equator the equator used for generate hashCode
* @return the hash code of the input collection using the hash method of an equator
* @throws NullPointerException if the equator is {@code null}
* @since 4.5
* @since 4.5.0
*/
public static <E> int hashCode(final Collection<? extends E> collection,
final Equator<? super E> equator) {
@ -1548,7 +1548,7 @@ public class CollectionUtils {
* @param count the specified number to remove, can't be less than 1
* @return collection of elements that removed from the input collection
* @throws NullPointerException if input is null
* @since 4.5
* @since 4.5.0
*/
public static <E> Collection<E> removeCount(final Collection<E> input, int startIndex, int count) {
Objects.requireNonNull(input, "input");
@ -1589,7 +1589,7 @@ public class CollectionUtils {
* @param endIndex the end index (exclusive) to remove, must not be less than startIndex
* @return collection of elements that removed from the input collection
* @throws NullPointerException if input is null
* @since 4.5
* @since 4.5.0
*/
public static <E> Collection<E> removeRange(final Collection<E> input, final int startIndex, final int endIndex) {
Objects.requireNonNull(input, "input");

2
src/main/java/org/apache/commons/collections4/EnumerationUtils.java
View File

@ -38,7 +38,7 @@ public class EnumerationUtils {
* @param <T> the element type
* @param enumeration the enumeration to use, may not be null
* @return a new, single use {@link Iterable}
* @since 4.5
* @since 4.5.0
*/
public static <T> Iterable<T> asIterable(final Enumeration<T> enumeration) {
return new IteratorIterable<>(new EnumerationIterator<>(enumeration));

4
src/main/java/org/apache/commons/collections4/ListUtils.java
View File

@ -182,7 +182,7 @@ public class ListUtils {
* @param list The list.
* @return the first element of a list.
* @see List#get(int)
* @since 4.5
* @since 4.5.0
*/
public static <T> T getFirst(final List<T> list) {
return Objects.requireNonNull(list, "list").get(0);
@ -197,7 +197,7 @@ public class ListUtils {
* @param list The list.
* @return the last element of a list.
* @see List#get(int)
* @since 4.5
* @since 4.5.0
*/
public static <T> T getLast(final List<T> list) {
return Objects.requireNonNull(list, "list").get(list.size() - 1);

34
src/main/java/org/apache/commons/collections4/MapUtils.java
View File

@ -267,7 +267,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a boolean, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the boolean conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Boolean getBoolean(final Map<? super K, ?> map, final K key,
final Function<K, Boolean> defaultFunction) {
@ -327,7 +327,7 @@ public class MapUtils {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a Boolean, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5
* @since 4.5.0
*/
public static <K> boolean getBooleanValue(final Map<? super K, ?> map, final K key,
final Function<K, Boolean> defaultFunction) {
@ -381,7 +381,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Byte getByte(final Map<? super K, ?> map, final K key, final Function<K, Byte> defaultFunction) {
return applyDefaultFunction(map, key, MapUtils::getByte, defaultFunction);
@ -431,7 +431,7 @@ public class MapUtils {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a byte, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5
* @since 4.5.0
*/
public static <K> byte getByteValue(final Map<? super K, ?> map, final K key,
final Function<K, Byte> defaultFunction) {
@ -485,7 +485,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Double getDouble(final Map<? super K, ?> map, final K key,
final Function<K, Double> defaultFunction) {
@ -536,7 +536,7 @@ public class MapUtils {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a double, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5
* @since 4.5.0
*/
public static <K> double getDoubleValue(final Map<? super K, ?> map, final K key,
final Function<K, Double> defaultFunction) {
@ -590,7 +590,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Float getFloat(final Map<? super K, ?> map, final K key,
final Function<K, Float> defaultFunction) {
@ -641,7 +641,7 @@ public class MapUtils {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a float, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5
* @since 4.5.0
*/
public static <K> float getFloatValue(final Map<? super K, ?> map, final K key,
final Function<K, Float> defaultFunction) {
@ -680,7 +680,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Integer getInteger(final Map<? super K, ?> map, final K key,
final Function<K, Integer> defaultFunction) {
@ -730,7 +730,7 @@ public class MapUtils {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as an int, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5
* @since 4.5.0
*/
public static <K> int getIntValue(final Map<? super K, ?> map, final K key,
final Function<K, Integer> defaultFunction) {
@ -785,7 +785,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Long getLong(final Map<? super K, ?> map, final K key, final Function<K, Long> defaultFunction) {
return applyDefaultFunction(map, key, MapUtils::getLong, defaultFunction);
@ -834,7 +834,7 @@ public class MapUtils {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a long, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5
* @since 4.5.0
*/
public static <K> long getLongValue(final Map<? super K, ?> map, final K key,
final Function<K, Long> defaultFunction) {
@ -888,7 +888,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the map conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Map<?, ?> getMap(final Map<? super K, ?> map, final K key,
final Function<K, Map<?, ?>> defaultFunction) {
@ -953,7 +953,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Number getNumber(final Map<? super K, ?> map, final K key,
final Function<K, Number> defaultFunction) {
@ -1043,7 +1043,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> Short getShort(final Map<? super K, ?> map, final K key,
final Function<K, Short> defaultFunction) {
@ -1093,7 +1093,7 @@ public class MapUtils {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a short, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5
* @since 4.5.0
*/
public static <K> short getShortValue(final Map<? super K, ?> map, final K key,
final Function<K, Short> defaultFunction) {
@ -1147,7 +1147,7 @@ public class MapUtils {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a string, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the string conversion fails
* @since 4.5
* @since 4.5.0
*/
public static <K> String getString(final Map<? super K, ?> map, final K key,
final Function<K, String> defaultFunction) {

4
src/main/java/org/apache/commons/collections4/properties/AbstractPropertiesFactory.java
View File

@ -43,7 +43,7 @@ public abstract class AbstractPropertiesFactory<T extends Properties> {
/**
* Enumerates property formats.
*
* @since 4.5
* @since 4.5.0
*/
public enum PropertyFormat {
@ -130,7 +130,7 @@ public abstract class AbstractPropertiesFactory<T extends Properties> {
* @return a new properties object.
* @throws IOException Thrown if an error occurred reading the input stream.
* @throws IllegalArgumentException Thrown if the input contains a malformed Unicode escape sequence.
* @since 4.5
* @since 4.5.0
*/
public T load(final InputStream inputStream, final PropertyFormat propertyFormat) throws IOException {
if (inputStream == null) {

2
src/main/java/org/apache/commons/collections4/properties/OrderedProperties.java
View File

@ -37,7 +37,7 @@ import java.util.stream.Collectors;
* </p>
*
* @see OrderedPropertiesFactory#INSTANCE
* @since 4.5
* @since 4.5.0
*/
public class OrderedProperties extends Properties {

2
src/main/java/org/apache/commons/collections4/properties/OrderedPropertiesFactory.java
View File

@ -21,7 +21,7 @@ package org.apache.commons.collections4.properties;
* Creates and loads {@link OrderedProperties}.
*
* @see OrderedProperties
* @since 4.5
* @since 4.5.0
*/
public class OrderedPropertiesFactory extends AbstractPropertiesFactory<OrderedProperties> {

2
src/main/java/org/apache/commons/collections4/properties/PropertiesFactory.java
View File

@ -294,7 +294,7 @@ public class PropertiesFactory extends AbstractPropertiesFactory<Properties> {
/**
* The empty map (immutable). This map is serializable.
*
* @since 4.5
* @since 4.5.0
*/
public static final Properties EMPTY_PROPERTIES = new EmptyProperties();

4
src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
View File

@ -113,7 +113,7 @@ public final class UnmodifiableNavigableSet<E>
}
/**
* @since 4.5
* @since 4.5.0
*/
@Override
public E pollFirst() {
@ -121,7 +121,7 @@ public final class UnmodifiableNavigableSet<E>
}
/**
* @since 4.5
* @since 4.5.0
*/
@Override
public E pollLast() {