ClassUtils.comparator().
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index bf8f492..75e17ff 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -60,6 +60,7 @@
<action type="add" dev="ggregory" due-to="Gary Gregory">Add and use ObjectUtils.getClass(T).</action>
<action type="add" dev="ggregory" due-to="Gary Gregory">Add and use ArrayUtils.newInstance(Class>T>, int).</action>
<action type="add" dev="ggregory" due-to="Gary Gregory">Add and use null-safe Streams.of(T...).</action>
+ <action type="add" dev="ggregory" due-to="Gary Gregory">Add ClassUtils.comparator().</action>
<!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump spotbugs-maven-plugin from 4.2.0 to 4.2.3 #735.</action>
<action type="update" dev="ggregory" due-to="Dependabot, XenoAmess">Bump Bump actions/cache from v2.1.4 to v2.1.6 #742, #752, #764.</action>
diff --git a/src/main/java/org/apache/commons/lang3/ClassUtils.java b/src/main/java/org/apache/commons/lang3/ClassUtils.java
index 728c63b..eb76ed1 100644
--- a/src/main/java/org/apache/commons/lang3/ClassUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ClassUtils.java
@@ -20,26 +20,31 @@
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collections;
+import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
import org.apache.commons.lang3.mutable.MutableObject;
/**
- * <p>Operates on classes without using reflection.</p>
+ * <p>
+ * Operates on classes without using reflection.
+ * </p>
*
- * <p>This class handles invalid {@code null} inputs as best it can.
- * Each method documents its behavior in more detail.</p>
+ * <p>
+ * This class handles invalid {@code null} inputs as best it can. Each method documents its behavior in more detail.
+ * </p>
*
- * <p>The notion of a {@code canonical name} includes the human
- * readable name for the type, for example {@code int[]}. The
- * non-canonical method variants work with the JVM names, such as
- * {@code [I}. </p>
+ * <p>
+ * The notion of a {@code canonical name} includes the human readable name for the type, for example {@code int[]}. The
+ * non-canonical method variants work with the JVM names, such as {@code [I}.
+ * </p>
*
* @since 2.0
*/
@@ -47,6 +52,7 @@
/**
* Inclusivity literals for {@link #hierarchy(Class, Interfaces)}.
+ *
* @since 3.2
*/
public enum Interfaces {
@@ -58,6 +64,8 @@
EXCLUDE
}
+ private static final Comparator<Class<?>> COMPARATOR = (o1, o2) -> Objects.compare(getName(o1), getName(o2), String::compareTo);
+
/**
* The package separator character: {@code '.' == {@value}}.
*/
@@ -82,38 +90,39 @@
* Maps names of primitives to their corresponding primitive {@code Class}es.
*/
private static final Map<String, Class<?>> namePrimitiveMap = new HashMap<>();
- static {
- namePrimitiveMap.put("boolean", Boolean.TYPE);
- namePrimitiveMap.put("byte", Byte.TYPE);
- namePrimitiveMap.put("char", Character.TYPE);
- namePrimitiveMap.put("short", Short.TYPE);
- namePrimitiveMap.put("int", Integer.TYPE);
- namePrimitiveMap.put("long", Long.TYPE);
- namePrimitiveMap.put("double", Double.TYPE);
- namePrimitiveMap.put("float", Float.TYPE);
- namePrimitiveMap.put("void", Void.TYPE);
- }
+ static {
+ namePrimitiveMap.put("boolean", Boolean.TYPE);
+ namePrimitiveMap.put("byte", Byte.TYPE);
+ namePrimitiveMap.put("char", Character.TYPE);
+ namePrimitiveMap.put("short", Short.TYPE);
+ namePrimitiveMap.put("int", Integer.TYPE);
+ namePrimitiveMap.put("long", Long.TYPE);
+ namePrimitiveMap.put("double", Double.TYPE);
+ namePrimitiveMap.put("float", Float.TYPE);
+ namePrimitiveMap.put("void", Void.TYPE);
+ }
/**
* Maps primitive {@code Class}es to their corresponding wrapper {@code Class}.
*/
private static final Map<Class<?>, Class<?>> primitiveWrapperMap = new HashMap<>();
- static {
- primitiveWrapperMap.put(Boolean.TYPE, Boolean.class);
- primitiveWrapperMap.put(Byte.TYPE, Byte.class);
- primitiveWrapperMap.put(Character.TYPE, Character.class);
- primitiveWrapperMap.put(Short.TYPE, Short.class);
- primitiveWrapperMap.put(Integer.TYPE, Integer.class);
- primitiveWrapperMap.put(Long.TYPE, Long.class);
- primitiveWrapperMap.put(Double.TYPE, Double.class);
- primitiveWrapperMap.put(Float.TYPE, Float.class);
- primitiveWrapperMap.put(Void.TYPE, Void.TYPE);
- }
+ static {
+ primitiveWrapperMap.put(Boolean.TYPE, Boolean.class);
+ primitiveWrapperMap.put(Byte.TYPE, Byte.class);
+ primitiveWrapperMap.put(Character.TYPE, Character.class);
+ primitiveWrapperMap.put(Short.TYPE, Short.class);
+ primitiveWrapperMap.put(Integer.TYPE, Integer.class);
+ primitiveWrapperMap.put(Long.TYPE, Long.class);
+ primitiveWrapperMap.put(Double.TYPE, Double.class);
+ primitiveWrapperMap.put(Float.TYPE, Float.class);
+ primitiveWrapperMap.put(Void.TYPE, Void.TYPE);
+ }
/**
* Maps wrapper {@code Class}es to their corresponding primitive types.
*/
private static final Map<Class<?>, Class<?>> wrapperPrimitiveMap = new HashMap<>();
+
static {
for (final Map.Entry<Class<?>, Class<?>> entry : primitiveWrapperMap.entrySet()) {
final Class<?> primitiveClass = entry.getKey();
@@ -123,7 +132,6 @@
}
}
}
-
/**
* Maps a primitive class name to its corresponding abbreviation used in array class names.
*/
@@ -133,6 +141,7 @@
* Maps an abbreviation used in array class names to corresponding primitive class name.
*/
private static final Map<String, String> reverseAbbreviationMap;
+
// Feed abbreviation maps
static {
final Map<String, String> m = new HashMap<>();
@@ -153,15 +162,26 @@
}
/**
- * <p>Given a {@code List} of {@code Class} objects, this method converts
- * them into class names.</p>
+ * Gets the class comparator, comparing by class name.
*
- * <p>A new {@code List} is returned. {@code null} objects will be copied into
- * the returned list as {@code null}.</p>
+ * @return the class comparator.
+ * @since 3.13.0
+ */
+ public static Comparator<Class<?>> comparator() {
+ return COMPARATOR;
+ }
+
+ /**
+ * <p>
+ * Given a {@code List} of {@code Class} objects, this method converts them into class names.
+ * </p>
*
- * @param classes the classes to change
- * @return a {@code List} of class names corresponding to the Class objects,
- * {@code null} if null input
+ * <p>
+ * A new {@code List} is returned. {@code null} objects will be copied into the returned list as {@code null}.
+ * </p>
+ *
+ * @param classes the classes to change
+ * @return a {@code List} of class names corresponding to the Class objects, {@code null} if null input
* @throws ClassCastException if {@code classes} contains a non-{@code Class} entry
*/
public static List<String> convertClassesToClassNames(final List<Class<?>> classes) {
@@ -180,15 +200,17 @@
}
/**
- * <p>Given a {@code List} of class names, this method converts them into classes.</p>
+ * <p>
+ * Given a {@code List} of class names, this method converts them into classes.
+ * </p>
*
- * <p>A new {@code List} is returned. If the class name cannot be found, {@code null}
- * is stored in the {@code List}. If the class name in the {@code List} is
- * {@code null}, {@code null} is stored in the output {@code List}.</p>
+ * <p>
+ * A new {@code List} is returned. If the class name cannot be found, {@code null} is stored in the {@code List}. If the
+ * class name in the {@code List} is {@code null}, {@code null} is stored in the output {@code List}.
+ * </p>
*
- * @param classNames the classNames to change
- * @return a {@code List} of Class objects corresponding to the class names,
- * {@code null} if null input
+ * @param classNames the classNames to change
+ * @return a {@code List} of Class objects corresponding to the class names, {@code null} if null input
* @throws ClassCastException if classNames contains a non String entry
*/
public static List<Class<?>> convertClassNamesToClasses(final List<String> classNames) {
@@ -207,59 +229,96 @@
}
/**
- * <p>Gets the abbreviated name of a {@code Class}.</p>
+ * <p>
+ * Gets the abbreviated name of a {@code Class}.
+ * </p>
*
- * @param cls the class to get the abbreviated name for, may be {@code null}
- * @param lengthHint the desired length of the abbreviated name
+ * @param cls the class to get the abbreviated name for, may be {@code null}
+ * @param lengthHint the desired length of the abbreviated name
* @return the abbreviated name or an empty string
* @throws IllegalArgumentException if len <= 0
* @see #getAbbreviatedName(String, int)
* @since 3.4
*/
public static String getAbbreviatedName(final Class<?> cls, final int lengthHint) {
- if (cls == null) {
- return StringUtils.EMPTY;
- }
- return getAbbreviatedName(cls.getName(), lengthHint);
+ if (cls == null) {
+ return StringUtils.EMPTY;
+ }
+ return getAbbreviatedName(cls.getName(), lengthHint);
}
/**
- * <p>Gets the abbreviated class name from a {@code String}.</p>
+ * <p>
+ * Gets the abbreviated class name from a {@code String}.
+ * </p>
*
- * <p>The string passed in is assumed to be a class name - it is not checked.</p>
+ * <p>
+ * The string passed in is assumed to be a class name - it is not checked.
+ * </p>
*
- * <p>The abbreviation algorithm will shorten the class name, usually without
- * significant loss of meaning.</p>
+ * <p>
+ * The abbreviation algorithm will shorten the class name, usually without significant loss of meaning.
+ * </p>
*
- * <p>The abbreviated class name will always include the complete package hierarchy.
- * If enough space is available, rightmost sub-packages will be displayed in full
- * length. The abbreviated package names will be shortened to a single character.</p>
- * <p>Only package names are shortened, the class simple name remains untouched. (See examples.)</p>
- * <p>The result will be longer than the desired length only if all the package names
- * shortened to a single character plus the class simple name with the separating dots
- * together are longer than the desired length. In other words, when the class name
- * cannot be shortened to the desired length.</p>
- * <p>If the class name can be shortened then
- * the final length will be at most {@code lengthHint} characters.</p>
- * <p>If the {@code lengthHint} is zero or negative then the method
- * throws exception. If you want to achieve the shortest possible version then
- * use {@code 1} as a {@code lengthHint}.</p>
+ * <p>
+ * The abbreviated class name will always include the complete package hierarchy. If enough space is available,
+ * rightmost sub-packages will be displayed in full length. The abbreviated package names will be shortened to a single
+ * character.
+ * </p>
+ * <p>
+ * Only package names are shortened, the class simple name remains untouched. (See examples.)
+ * </p>
+ * <p>
+ * The result will be longer than the desired length only if all the package names shortened to a single character plus
+ * the class simple name with the separating dots together are longer than the desired length. In other words, when the
+ * class name cannot be shortened to the desired length.
+ * </p>
+ * <p>
+ * If the class name can be shortened then the final length will be at most {@code lengthHint} characters.
+ * </p>
+ * <p>
+ * If the {@code lengthHint} is zero or negative then the method throws exception. If you want to achieve the shortest
+ * possible version then use {@code 1} as a {@code lengthHint}.
+ * </p>
*
* <table>
* <caption>Examples</caption>
- * <tr><td>className</td><td>len</td><td>return</td></tr>
- * <tr><td> null</td><td> 1</td><td>""</td></tr>
- * <tr><td>"java.lang.String"</td><td> 5</td><td>"j.l.String"</td></tr>
- * <tr><td>"java.lang.String"</td><td>15</td><td>"j.lang.String"</td></tr>
- * <tr><td>"java.lang.String"</td><td>30</td><td>"java.lang.String"</td></tr>
- * <tr><td>"org.apache.commons.lang3.ClassUtils"</td><td>18</td><td>"o.a.c.l.ClassUtils"</td></tr>
+ * <tr>
+ * <td>className</td>
+ * <td>len</td>
+ * <td>return</td>
+ * </tr>
+ * <tr>
+ * <td>null</td>
+ * <td>1</td>
+ * <td>""</td>
+ * </tr>
+ * <tr>
+ * <td>"java.lang.String"</td>
+ * <td>5</td>
+ * <td>"j.l.String"</td>
+ * </tr>
+ * <tr>
+ * <td>"java.lang.String"</td>
+ * <td>15</td>
+ * <td>"j.lang.String"</td>
+ * </tr>
+ * <tr>
+ * <td>"java.lang.String"</td>
+ * <td>30</td>
+ * <td>"java.lang.String"</td>
+ * </tr>
+ * <tr>
+ * <td>"org.apache.commons.lang3.ClassUtils"</td>
+ * <td>18</td>
+ * <td>"o.a.c.l.ClassUtils"</td>
+ * </tr>
* </table>
*
* @param className the className to get the abbreviated name for, may be {@code null}
- * @param lengthHint the desired length of the abbreviated name
- * @return the abbreviated name or an empty string if the specified
- * class name is {@code null} or empty string. The abbreviated name may be
- * longer than the desired length if it cannot be abbreviated to the desired length.
+ * @param lengthHint the desired length of the abbreviated name
+ * @return the abbreviated name or an empty string if the specified class name is {@code null} or empty string. The
+ * abbreviated name may be longer than the desired length if it cannot be abbreviated to the desired length.
* @throws IllegalArgumentException if {@code len <= 0}
* @since 3.4
*/
@@ -284,8 +343,7 @@
}
++target;
- if (useFull(runAheadTarget, source, abbreviated.length, lengthHint)
- || target > runAheadTarget) {
+ if (useFull(runAheadTarget, source, abbreviated.length, lengthHint) || target > runAheadTarget) {
target = runAheadTarget;
}
@@ -298,17 +356,18 @@
}
/**
- * <p>Gets a {@code List} of all interfaces implemented by the given
- * class and its superclasses.</p>
+ * <p>
+ * Gets a {@code List} of all interfaces implemented by the given class and its superclasses.
+ * </p>
*
- * <p>The order is determined by looking through each interface in turn as
- * declared in the source file and following its hierarchy up. Then each
- * superclass is considered in the same way. Later duplicates are ignored,
- * so the order is maintained.</p>
+ * <p>
+ * The order is determined by looking through each interface in turn as declared in the source file and following its
+ * hierarchy up. Then each superclass is considered in the same way. Later duplicates are ignored, so the order is
+ * maintained.
+ * </p>
*
- * @param cls the class to look up, may be {@code null}
- * @return the {@code List} of interfaces in order,
- * {@code null} if null input
+ * @param cls the class to look up, may be {@code null}
+ * @return the {@code List} of interfaces in order, {@code null} if null input
*/
public static List<Class<?>> getAllInterfaces(final Class<?> cls) {
if (cls == null) {
@@ -324,7 +383,7 @@
/**
* Gets the interfaces for the specified class.
*
- * @param cls the class to look up, may be {@code null}
+ * @param cls the class to look up, may be {@code null}
* @param interfacesFound the {@code Set} of interfaces for the class
*/
private static void getAllInterfaces(Class<?> cls, final HashSet<Class<?>> interfacesFound) {
@@ -338,15 +397,16 @@
}
cls = cls.getSuperclass();
- }
- }
+ }
+ }
/**
- * <p>Gets a {@code List} of superclasses for the given class.</p>
+ * <p>
+ * Gets a {@code List} of superclasses for the given class.
+ * </p>
*
- * @param cls the class to look up, may be {@code null}
- * @return the {@code List} of superclasses in order going up from this one
- * {@code null} if null input
+ * @param cls the class to look up, may be {@code null}
+ * @return the {@code List} of superclasses in order going up from this one {@code null} if null input
*/
public static List<Class<?>> getAllSuperclasses(final Class<?> cls) {
if (cls == null) {
@@ -362,7 +422,9 @@
}
/**
- * <p>Gets the canonical class name for a {@code Class}.</p>
+ * <p>
+ * Gets the canonical class name for a {@code Class}.
+ * </p>
*
* @param cls the class for which to get the canonical class name; may be null
* @return the canonical name of the class, or the empty String
@@ -374,10 +436,12 @@
}
/**
- * <p>Gets the canonical name for a {@code Class}.</p>
+ * <p>
+ * Gets the canonical name for a {@code Class}.
+ * </p>
*
* @param cls the class for which to get the canonical class name; may be null
- * @param valueIfNull the return value if null
+ * @param valueIfNull the return value if null
* @return the canonical name of the class, or {@code valueIfNull}
* @since 3.7
* @see Class#getCanonicalName()
@@ -391,7 +455,9 @@
}
/**
- * <p>Gets the canonical name for an {@code Object}.</p>
+ * <p>
+ * Gets the canonical name for an {@code Object}.
+ * </p>
*
* @param object the object for which to get the canonical class name; may be null
* @return the canonical name of the object, or the empty String
@@ -403,10 +469,12 @@
}
/**
- * <p>Gets the canonical name for an {@code Object}.</p>
+ * <p>
+ * Gets the canonical name for an {@code Object}.
+ * </p>
*
* @param object the object for which to get the canonical class name; may be null
- * @param valueIfNull the return value if null
+ * @param valueIfNull the return value if null
* @return the canonical name of the object or {@code valueIfNull}
* @since 3.7
* @see Class#getCanonicalName()
@@ -420,14 +488,17 @@
}
/**
- * <p>Converts a given name of class into canonical format.
- * If name of class is not a name of array class it returns
- * unchanged name.</p>
+ * <p>
+ * Converts a given name of class into canonical format. If name of class is not a name of array class it returns
+ * unchanged name.
+ * </p>
*
- * <p>The method does not change the {@code $} separators in case
- * the class is inner class.</p>
+ * <p>
+ * The method does not change the {@code $} separators in case the class is inner class.
+ * </p>
*
- * <p>Example:
+ * <p>
+ * Example:
* <ul>
* <li>{@code getCanonicalName("[I") = "int[]"}</li>
* <li>{@code getCanonicalName("[Ljava.lang.String;") = "java.lang.String[]"}</li>
@@ -453,11 +524,7 @@
return className;
}
if (className.startsWith("L")) {
- className = className.substring(
- 1,
- className.endsWith(";")
- ? className.length() - 1
- : className.length());
+ className = className.substring(1, className.endsWith(";") ? className.length() - 1 : className.length());
} else if (!className.isEmpty()) {
className = reverseAbbreviationMap.get(className.substring(0, 1));
}
@@ -469,14 +536,12 @@
}
/**
- * Returns the (initialized) class represented by {@code className}
- * using the {@code classLoader}. This implementation supports
- * the syntaxes "{@code java.util.Map.Entry[]}",
- * "{@code java.util.Map$Entry[]}", "{@code [Ljava.util.Map.Entry;}",
- * and "{@code [Ljava.util.Map$Entry;}".
+ * Returns the (initialized) class represented by {@code className} using the {@code classLoader}. This implementation
+ * supports the syntaxes "{@code java.util.Map.Entry[]}", "{@code java.util.Map$Entry[]}",
+ * "{@code [Ljava.util.Map.Entry;}", and "{@code [Ljava.util.Map$Entry;}".
*
- * @param classLoader the class loader to use to load the class
- * @param className the class name
+ * @param classLoader the class loader to use to load the class
+ * @param className the class name
* @return the class represented by {@code className} using the {@code classLoader}
* @throws ClassNotFoundException if the class is not found
*/
@@ -485,19 +550,17 @@
}
/**
- * Returns the class represented by {@code className} using the
- * {@code classLoader}. This implementation supports the syntaxes
- * "{@code java.util.Map.Entry[]}", "{@code java.util.Map$Entry[]}",
- * "{@code [Ljava.util.Map.Entry;}", and "{@code [Ljava.util.Map$Entry;}".
+ * Returns the class represented by {@code className} using the {@code classLoader}. This implementation supports the
+ * syntaxes "{@code java.util.Map.Entry[]}", "{@code java.util.Map$Entry[]}", "{@code [Ljava.util.Map.Entry;}", and
+ * "{@code [Ljava.util.Map$Entry;}".
*
- * @param classLoader the class loader to use to load the class
- * @param className the class name
- * @param initialize whether the class must be initialized
+ * @param classLoader the class loader to use to load the class
+ * @param className the class name
+ * @param initialize whether the class must be initialized
* @return the class represented by {@code className} using the {@code classLoader}
* @throws ClassNotFoundException if the class is not found
*/
- public static Class<?> getClass(
- final ClassLoader classLoader, final String className, final boolean initialize) throws ClassNotFoundException {
+ public static Class<?> getClass(final ClassLoader classLoader, final String className, final boolean initialize) throws ClassNotFoundException {
try {
final Class<?> clazz;
if (namePrimitiveMap.containsKey(className)) {
@@ -512,9 +575,8 @@
if (lastDotIndex != -1) {
try {
- return getClass(classLoader, className.substring(0, lastDotIndex) +
- INNER_CLASS_SEPARATOR_CHAR + className.substring(lastDotIndex + 1),
- initialize);
+ return getClass(classLoader, className.substring(0, lastDotIndex) + INNER_CLASS_SEPARATOR_CHAR + className.substring(lastDotIndex + 1),
+ initialize);
} catch (final ClassNotFoundException ex2) { // NOPMD
// ignore exception
}
@@ -525,13 +587,11 @@
}
/**
- * Returns the (initialized) class represented by {@code className}
- * using the current thread's context class loader. This implementation
- * supports the syntaxes "{@code java.util.Map.Entry[]}",
- * "{@code java.util.Map$Entry[]}", "{@code [Ljava.util.Map.Entry;}",
- * and "{@code [Ljava.util.Map$Entry;}".
+ * Returns the (initialized) class represented by {@code className} using the current thread's context class loader.
+ * This implementation supports the syntaxes "{@code java.util.Map.Entry[]}", "{@code java.util.Map$Entry[]}",
+ * "{@code [Ljava.util.Map.Entry;}", and "{@code [Ljava.util.Map$Entry;}".
*
- * @param className the class name
+ * @param className the class name
* @return the class represented by {@code className} using the current thread's context class loader
* @throws ClassNotFoundException if the class is not found
*/
@@ -540,13 +600,12 @@
}
/**
- * Returns the class represented by {@code className} using the
- * current thread's context class loader. This implementation supports the
- * syntaxes "{@code java.util.Map.Entry[]}", "{@code java.util.Map$Entry[]}",
+ * Returns the class represented by {@code className} using the current thread's context class loader. This
+ * implementation supports the syntaxes "{@code java.util.Map.Entry[]}", "{@code java.util.Map$Entry[]}",
* "{@code [Ljava.util.Map.Entry;}", and "{@code [Ljava.util.Map$Entry;}".
*
- * @param className the class name
- * @param initialize whether the class must be initialized
+ * @param className the class name
+ * @param initialize whether the class must be initialized
* @return the class represented by {@code className} using the current thread's context class loader
* @throws ClassNotFoundException if the class is not found
*/
@@ -571,7 +630,9 @@
}
/**
- * <p>Null-safe version of {@code cls.getName()}</p>
+ * <p>
+ * Null-safe version of {@code cls.getName()}
+ * </p>
*
* @param cls the class for which to get the class name; may be null
* @return the class name or the empty string in case the argument is {@code null}
@@ -583,7 +644,9 @@
}
/**
- * <p>Null-safe version of {@code cls.getName()}</p>
+ * <p>
+ * Null-safe version of {@code cls.getName()}
+ * </p>
*
* @param cls the class for which to get the class name; may be null
* @param valueIfNull the return value if the argument {@code cls} is {@code null}
@@ -596,7 +659,9 @@
}
/**
- * <p>Null-safe version of {@code object.getClass().getName()}</p>
+ * <p>
+ * Null-safe version of {@code object.getClass().getName()}
+ * </p>
*
* @param object the object for which to get the class name; may be null
* @return the class name or the empty String
@@ -608,7 +673,9 @@
}
/**
- * <p>Null-safe version of {@code object.getClass().getSimpleName()}</p>
+ * <p>
+ * Null-safe version of {@code object.getClass().getSimpleName()}
+ * </p>
*
* @param object the object for which to get the class name; may be null
* @param valueIfNull the value to return if {@code object} is {@code null}
@@ -621,9 +688,11 @@
}
/**
- * <p>Gets the package name from the canonical name of a {@code Class}.</p>
+ * <p>
+ * Gets the package name from the canonical name of a {@code Class}.
+ * </p>
*
- * @param cls the class to get the package name for, may be {@code null}.
+ * @param cls the class to get the package name for, may be {@code null}.
* @return the package name or an empty string
* @since 2.4
*/
@@ -635,10 +704,12 @@
}
/**
- * <p>Gets the package name from the class name of an {@code Object}.</p>
+ * <p>
+ * Gets the package name from the class name of an {@code Object}.
+ * </p>
*
- * @param object the class to get the package name for, may be null
- * @param valueIfNull the value to return if null
+ * @param object the class to get the package name for, may be null
+ * @param valueIfNull the value to return if null
* @return the package name of the object, or the null value
* @since 2.4
*/
@@ -650,12 +721,18 @@
}
/**
- * <p>Gets the package name from the class name. </p>
+ * <p>
+ * Gets the package name from the class name.
+ * </p>
*
- * <p>The string passed in is assumed to be a class name - it is not checked.</p>
- * <p>If the class is in the default package, return an empty string.</p>
+ * <p>
+ * The string passed in is assumed to be a class name - it is not checked.
+ * </p>
+ * <p>
+ * If the class is in the default package, return an empty string.
+ * </p>
*
- * @param name the name to get the package name for, may be {@code null}
+ * @param name the name to get the package name for, may be {@code null}
* @return the package name or an empty string
* @since 2.4
*/
@@ -664,9 +741,11 @@
}
/**
- * <p>Gets the package name of a {@code Class}.</p>
+ * <p>
+ * Gets the package name of a {@code Class}.
+ * </p>
*
- * @param cls the class to get the package name for, may be {@code null}.
+ * @param cls the class to get the package name for, may be {@code null}.
* @return the package name or an empty string
*/
public static String getPackageName(final Class<?> cls) {
@@ -679,10 +758,12 @@
// Package name
// ----------------------------------------------------------------------
/**
- * <p>Gets the package name of an {@code Object}.</p>
+ * <p>
+ * Gets the package name of an {@code Object}.
+ * </p>
*
- * @param object the class to get the package name for, may be null
- * @param valueIfNull the value to return if null
+ * @param object the class to get the package name for, may be null
+ * @param valueIfNull the value to return if null
* @return the package name of the object, or the null value
*/
public static String getPackageName(final Object object, final String valueIfNull) {
@@ -693,12 +774,18 @@
}
/**
- * <p>Gets the package name from a {@code String}.</p>
+ * <p>
+ * Gets the package name from a {@code String}.
+ * </p>
*
- * <p>The string passed in is assumed to be a class name - it is not checked.</p>
- * <p>If the class is unpackaged, return an empty string.</p>
+ * <p>
+ * The string passed in is assumed to be a class name - it is not checked.
+ * </p>
+ * <p>
+ * If the class is unpackaged, return an empty string.
+ * </p>
*
- * @param className the className to get the package name for, may be {@code null}
+ * @param className the className to get the package name for, may be {@code null}
* @return the package name or an empty string
*/
public static String getPackageName(String className) {
@@ -723,29 +810,28 @@
}
/**
- * <p>Returns the desired Method much like {@code Class.getMethod}, however
- * it ensures that the returned Method is from a public class or interface and not
- * from an anonymous inner class. This means that the Method is invokable and
- * doesn't fall foul of Java bug
- * <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4071957">4071957</a>).</p>
+ * <p>
+ * Returns the desired Method much like {@code Class.getMethod}, however it ensures that the returned Method is from a
+ * public class or interface and not from an anonymous inner class. This means that the Method is invokable and doesn't
+ * fall foul of Java bug <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4071957">4071957</a>).
+ * </p>
*
- * <pre>
+ * <pre>
* <code>Set set = Collections.unmodifiableSet(...);
* Method method = ClassUtils.getPublicMethod(set.getClass(), "isEmpty", new Class[0]);
* Object result = method.invoke(set, new Object[]);</code>
- * </pre>
+ * </pre>
*
- * @param cls the class to check, not null
- * @param methodName the name of the method
- * @param parameterTypes the list of parameters
+ * @param cls the class to check, not null
+ * @param methodName the name of the method
+ * @param parameterTypes the list of parameters
* @return the method
* @throws NullPointerException if the class is null
* @throws SecurityException if a security violation occurred
- * @throws NoSuchMethodException if the method is not found in the given class
- * or if the method doesn't conform with the requirements
+ * @throws NoSuchMethodException if the method is not found in the given class or if the method doesn't conform with the
+ * requirements
*/
- public static Method getPublicMethod(final Class<?> cls, final String methodName, final Class<?>... parameterTypes)
- throws NoSuchMethodException {
+ public static Method getPublicMethod(final Class<?> cls, final String methodName, final Class<?>... parameterTypes) throws NoSuchMethodException {
final Method declaredMethod = cls.getMethod(methodName, parameterTypes);
if (Modifier.isPublic(declaredMethod.getDeclaringClass().getModifiers())) {
@@ -770,12 +856,13 @@
}
}
- throw new NoSuchMethodException("Can't find a public method for " +
- methodName + " " + ArrayUtils.toString(parameterTypes));
+ throw new NoSuchMethodException("Can't find a public method for " + methodName + " " + ArrayUtils.toString(parameterTypes));
}
/**
- * <p>Gets the canonical name minus the package name from a {@code Class}.</p>
+ * <p>
+ * Gets the canonical name minus the package name from a {@code Class}.
+ * </p>
*
* @param cls the class for which to get the short canonical class name; may be null
* @return the canonical name without the package name or an empty string
@@ -789,10 +876,12 @@
}
/**
- * <p>Gets the canonical name minus the package name for an {@code Object}.</p>
+ * <p>
+ * Gets the canonical name minus the package name for an {@code Object}.
+ * </p>
*
- * @param object the class to get the short name for, may be null
- * @param valueIfNull the value to return if null
+ * @param object the class to get the short name for, may be null
+ * @param valueIfNull the value to return if null
* @return the canonical name of the object without the package name, or the null value
* @since 2.4
*/
@@ -804,45 +893,98 @@
}
/**
- * <p>Gets the canonical name minus the package name from a String.</p>
+ * <p>
+ * Gets the canonical name minus the package name from a String.
+ * </p>
*
- * <p>The string passed in is assumed to be a class name - it is not checked.</p>
+ * <p>
+ * The string passed in is assumed to be a class name - it is not checked.
+ * </p>
*
- * <p>Note that this method is mainly designed to handle the arrays and primitives properly.
- * If the class is an inner class then the result value will not contain the outer classes.
- * This way the behavior of this method is different from {@link #getShortClassName(String)}.
- * The argument in that case is class name and not canonical name and the return value
- * retains the outer classes.</p>
+ * <p>
+ * Note that this method is mainly designed to handle the arrays and primitives properly. If the class is an inner class
+ * then the result value will not contain the outer classes. This way the behavior of this method is different from
+ * {@link #getShortClassName(String)}. The argument in that case is class name and not canonical name and the return
+ * value retains the outer classes.
+ * </p>
*
- * <p>Note that there is no way to reliably identify the part of the string representing the
- * package hierarchy and the part that is the outer class or classes in case of an inner class.
- * Trying to find the class would require reflective call and the class itself may not even be
- * on the class path. Relying on the fact that class names start with capital letter and packages
- * with lower case is heuristic.</p>
+ * <p>
+ * Note that there is no way to reliably identify the part of the string representing the package hierarchy and the part
+ * that is the outer class or classes in case of an inner class. Trying to find the class would require reflective call
+ * and the class itself may not even be on the class path. Relying on the fact that class names start with capital
+ * letter and packages with lower case is heuristic.
+ * </p>
*
- * <p>It is recommended to use {@link #getShortClassName(String)} for cases when the class
- * is an inner class and use this method for cases it is designed for.</p>
+ * <p>
+ * It is recommended to use {@link #getShortClassName(String)} for cases when the class is an inner class and use this
+ * method for cases it is designed for.
+ * </p>
*
* <table>
* <caption>Examples</caption>
- * <tr><td>return value</td><td>input</td></tr>
- * <tr><td>{@code ""}</td><td>{@code (String)null}</td></tr>
- * <tr><td>{@code "Map.Entry"}</td><td>{@code java.util.Map.Entry.class.getName()}</td></tr>
- * <tr><td>{@code "Entry"}</td><td>{@code java.util.Map.Entry.class.getCanonicalName()}</td></tr>
- * <tr><td>{@code "ClassUtils"}</td><td>{@code "org.apache.commons.lang3.ClassUtils"}</td></tr>
- * <tr><td>{@code "ClassUtils[]"}</td><td>{@code "[Lorg.apache.commons.lang3.ClassUtils;"}</td></tr>
- * <tr><td>{@code "ClassUtils[][]"}</td><td>{@code "[[Lorg.apache.commons.lang3.ClassUtils;"}</td></tr>
- * <tr><td>{@code "ClassUtils[]"}</td><td>{@code "org.apache.commons.lang3.ClassUtils[]"}</td></tr>
- * <tr><td>{@code "ClassUtils[][]"}</td><td>{@code "org.apache.commons.lang3.ClassUtils[][]"}</td></tr>
- * <tr><td>{@code "int[]"}</td><td>{@code "[I"}</td></tr>
- * <tr><td>{@code "int[]"}</td><td>{@code int[].class.getCanonicalName()}</td></tr>
- * <tr><td>{@code "int[]"}</td><td>{@code int[].class.getName()}</td></tr>
- * <tr><td>{@code "int[][]"}</td><td>{@code "[[I"}</td></tr>
- * <tr><td>{@code "int[]"}</td><td>{@code "int[]"}</td></tr>
- * <tr><td>{@code "int[][]"}</td><td>{@code "int[][]"}</td></tr>
+ * <tr>
+ * <td>return value</td>
+ * <td>input</td>
+ * </tr>
+ * <tr>
+ * <td>{@code ""}</td>
+ * <td>{@code (String)null}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "Map.Entry"}</td>
+ * <td>{@code java.util.Map.Entry.class.getName()}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "Entry"}</td>
+ * <td>{@code java.util.Map.Entry.class.getCanonicalName()}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "ClassUtils"}</td>
+ * <td>{@code "org.apache.commons.lang3.ClassUtils"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "ClassUtils[]"}</td>
+ * <td>{@code "[Lorg.apache.commons.lang3.ClassUtils;"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "ClassUtils[][]"}</td>
+ * <td>{@code "[[Lorg.apache.commons.lang3.ClassUtils;"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "ClassUtils[]"}</td>
+ * <td>{@code "org.apache.commons.lang3.ClassUtils[]"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "ClassUtils[][]"}</td>
+ * <td>{@code "org.apache.commons.lang3.ClassUtils[][]"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "int[]"}</td>
+ * <td>{@code "[I"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "int[]"}</td>
+ * <td>{@code int[].class.getCanonicalName()}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "int[]"}</td>
+ * <td>{@code int[].class.getName()}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "int[][]"}</td>
+ * <td>{@code "[[I"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "int[]"}</td>
+ * <td>{@code "int[]"}</td>
+ * </tr>
+ * <tr>
+ * <td>{@code "int[][]"}</td>
+ * <td>{@code "int[][]"}</td>
+ * </tr>
* </table>
*
- * @param canonicalName the class name to get the short name for
+ * @param canonicalName the class name to get the short name for
* @return the canonical name of the class without the package name or an empty string
* @since 2.4
*/
@@ -851,15 +993,18 @@
}
/**
- * <p>Gets the class name minus the package name from a {@code Class}.</p>
+ * <p>
+ * Gets the class name minus the package name from a {@code Class}.
+ * </p>
*
- * <p>This method simply gets the name using {@code Class.getName()} and then calls
- * {@link #getShortClassName(Class)}. See relevant notes there.</p>
+ * <p>
+ * This method simply gets the name using {@code Class.getName()} and then calls {@link #getShortClassName(Class)}. See
+ * relevant notes there.
+ * </p>
*
- * @param cls the class to get the short name for.
- * @return the class name without the package name or an empty string. If the class
- * is an inner class then the returned value will contain the outer class
- * or classes separated with {@code .} (dot) character.
+ * @param cls the class to get the short name for.
+ * @return the class name without the package name or an empty string. If the class is an inner class then the returned
+ * value will contain the outer class or classes separated with {@code .} (dot) character.
*/
public static String getShortClassName(final Class<?> cls) {
if (cls == null) {
@@ -869,15 +1014,19 @@
}
/**
- * <p>Gets the class name of the {@code object} without the package name or names.</p>
+ * <p>
+ * Gets the class name of the {@code object} without the package name or names.
+ * </p>
*
- * <p>The method looks up the class of the object and then converts the name of the class invoking
- * {@link #getShortClassName(Class)} (see relevant notes there).</p>
+ * <p>
+ * The method looks up the class of the object and then converts the name of the class invoking
+ * {@link #getShortClassName(Class)} (see relevant notes there).
+ * </p>
*
- * @param object the class to get the short name for, may be {@code null}
- * @param valueIfNull the value to return if the object is {@code null}
- * @return the class name of the object without the package name, or {@code valueIfNull}
- * if the argument {@code object} is {@code null}
+ * @param object the class to get the short name for, may be {@code null}
+ * @param valueIfNull the value to return if the object is {@code null}
+ * @return the class name of the object without the package name, or {@code valueIfNull} if the argument {@code object}
+ * is {@code null}
*/
public static String getShortClassName(final Object object, final String valueIfNull) {
if (object == null) {
@@ -887,29 +1036,37 @@
}
/**
- * <p>Gets the class name minus the package name from a String.</p>
+ * <p>
+ * Gets the class name minus the package name from a String.
+ * </p>
*
- * <p>The string passed in is assumed to be a class name - it is not checked. The string has to be formatted the way
- * as the JDK method {@code Class.getName()} returns it, and not the usual way as we write it, for example in import
- * statements, or as it is formatted by {@code Class.getCanonicalName()}.</p>
+ * <p>
+ * The string passed in is assumed to be a class name - it is not checked. The string has to be formatted the way as the
+ * JDK method {@code Class.getName()} returns it, and not the usual way as we write it, for example in import
+ * statements, or as it is formatted by {@code Class.getCanonicalName()}.
+ * </p>
*
- * <p>The difference is is significant only in case of classes that are inner classes of some other
- * classes. In this case the separator between the outer and inner class (possibly on multiple hierarchy level) has
- * to be {@code $} (dollar sign) and not {@code .} (dot), as it is returned by {@code Class.getName()}</p>
+ * <p>
+ * The difference is is significant only in case of classes that are inner classes of some other classes. In this case
+ * the separator between the outer and inner class (possibly on multiple hierarchy level) has to be {@code $} (dollar
+ * sign) and not {@code .} (dot), as it is returned by {@code Class.getName()}
+ * </p>
*
- * <p>Note that this method is called from the {@link #getShortClassName(Class)} method using the string
- * returned by {@code Class.getName()}.</p>
+ * <p>
+ * Note that this method is called from the {@link #getShortClassName(Class)} method using the string returned by
+ * {@code Class.getName()}.
+ * </p>
*
- * <p>Note that this method differs from {@link #getSimpleName(Class)} in that this will
- * return, for example {@code "Map.Entry"} whilst the {@code java.lang.Class} variant will simply
- * return {@code "Entry"}. In this example the argument {@code className} is the string
- * {@code java.util.Map$Entry} (note the {@code $} sign.</p>
+ * <p>
+ * Note that this method differs from {@link #getSimpleName(Class)} in that this will return, for example
+ * {@code "Map.Entry"} whilst the {@code java.lang.Class} variant will simply return {@code "Entry"}. In this example
+ * the argument {@code className} is the string {@code java.util.Map$Entry} (note the {@code $} sign.
+ * </p>
*
- * @param className the className to get the short name for. It has to be formatted as returned by
- * {@code Class.getName()} and not {@code Class.getCanonicalName()}
- * @return the class name of the class without the package name or an empty string. If the class is
- * an inner class then value contains the outer class or classes and the separator is replaced
- * to be {@code .} (dot) character.
+ * @param className the className to get the short name for. It has to be formatted as returned by
+ * {@code Class.getName()} and not {@code Class.getCanonicalName()}
+ * @return the class name of the class without the package name or an empty string. If the class is an inner class then
+ * value contains the outer class or classes and the separator is replaced to be {@code .} (dot) character.
*/
public static String getShortClassName(String className) {
if (StringUtils.isEmpty(className)) {
@@ -935,8 +1092,7 @@
}
final int lastDotIdx = className.lastIndexOf(PACKAGE_SEPARATOR_CHAR);
- final int innerIdx = className.indexOf(
- INNER_CLASS_SEPARATOR_CHAR, lastDotIdx == -1 ? 0 : lastDotIdx + 1);
+ final int innerIdx = className.indexOf(INNER_CLASS_SEPARATOR_CHAR, lastDotIdx == -1 ? 0 : lastDotIdx + 1);
String out = className.substring(lastDotIdx + 1);
if (innerIdx != -1) {
out = out.replace(INNER_CLASS_SEPARATOR_CHAR, PACKAGE_SEPARATOR_CHAR);
@@ -945,7 +1101,9 @@
}
/**
- * <p>Null-safe version of {@code cls.getSimpleName()}</p>
+ * <p>
+ * Null-safe version of {@code cls.getSimpleName()}
+ * </p>
*
* @param cls the class for which to get the simple name; may be null
* @return the simple class name or the empty string in case the argument is {@code null}
@@ -957,12 +1115,13 @@
}
/**
- * <p>Null-safe version of {@code cls.getSimpleName()}</p>
+ * <p>
+ * Null-safe version of {@code cls.getSimpleName()}
+ * </p>
*
* @param cls the class for which to get the simple name; may be null
- * @param valueIfNull the value to return if null
- * @return the simple class name or {@code valueIfNull} if the
- * argument {@code cls} is {@code null}
+ * @param valueIfNull the value to return if null
+ * @return the simple class name or {@code valueIfNull} if the argument {@code cls} is {@code null}
* @since 3.0
* @see Class#getSimpleName()
*/
@@ -971,13 +1130,17 @@
}
/**
- * <p>Null-safe version of {@code object.getClass().getSimpleName()}</p>
+ * <p>
+ * Null-safe version of {@code object.getClass().getSimpleName()}
+ * </p>
*
- * <p>It is to note that this method is overloaded and in case the argument {@code object} is a
- * {@code Class} object then the {@link #getSimpleName(Class)} will be invoked. If this is
- * a significant possibility then the caller should check this case and call {@code
- * getSimpleName(Class.class)} or just simply use the string literal {@code "Class"}, which
- * is the result of the method in that case.</p>
+ * <p>
+ * It is to note that this method is overloaded and in case the argument {@code object} is a {@code Class} object then
+ * the {@link #getSimpleName(Class)} will be invoked. If this is a significant possibility then the caller should check
+ * this case and call {@code
+ * getSimpleName(Class.class)} or just simply use the string literal {@code "Class"}, which is the result of the method
+ * in that case.
+ * </p>
*
* @param object the object for which to get the simple class name; may be null
* @return the simple class name or the empty string in case the argument is {@code null}
@@ -989,12 +1152,13 @@
}
/**
- * <p>Null-safe version of {@code object.getClass().getSimpleName()}</p>
+ * <p>
+ * Null-safe version of {@code object.getClass().getSimpleName()}
+ * </p>
*
* @param object the object for which to get the simple class name; may be null
* @param valueIfNull the value to return if {@code object} is {@code null}
- * @return the simple class name or {@code valueIfNull} if the
- * argument {@code object} is {@code null}
+ * @return the simple class name or {@code valueIfNull} if the argument {@code object} is {@code null}
* @since 3.0
* @see Class#getSimpleName()
*/
@@ -1094,34 +1258,40 @@
}
/**
- * <p>Checks if one {@code Class} can be assigned to a variable of
- * another {@code Class}.</p>
+ * <p>
+ * Checks if one {@code Class} can be assigned to a variable of another {@code Class}.
+ * </p>
*
- * <p>Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method,
- * this method takes into account widenings of primitive classes and
- * {@code null}s.</p>
+ * <p>
+ * Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method, this method takes into account widenings of
+ * primitive classes and {@code null}s.
+ * </p>
*
- * <p>Primitive widenings allow an int to be assigned to a long, float or
- * double. This method returns the correct result for these cases.</p>
+ * <p>
+ * Primitive widenings allow an int to be assigned to a long, float or double. This method returns the correct result
+ * for these cases.
+ * </p>
*
- * <p>{@code Null} may be assigned to any reference type. This method
- * will return {@code true} if {@code null} is passed in and the
- * toClass is non-primitive.</p>
+ * <p>
+ * {@code Null} may be assigned to any reference type. This method will return {@code true} if {@code null} is passed in
+ * and the toClass is non-primitive.
+ * </p>
*
- * <p>Specifically, this method tests whether the type represented by the
- * specified {@code Class} parameter can be converted to the type
- * represented by this {@code Class} object via an identity conversion
- * widening primitive or widening reference conversion. See
- * <em><a href="http://docs.oracle.com/javase/specs/">The Java Language Specification</a></em>,
- * sections 5.1.1, 5.1.2 and 5.1.4 for details.</p>
+ * <p>
+ * Specifically, this method tests whether the type represented by the specified {@code Class} parameter can be
+ * converted to the type represented by this {@code Class} object via an identity conversion widening primitive or
+ * widening reference conversion. See <em><a href="http://docs.oracle.com/javase/specs/">The Java Language
+ * Specification</a></em>, sections 5.1.1, 5.1.2 and 5.1.4 for details.
+ * </p>
*
- * <p><strong>Since Lang 3.0,</strong> this method will default behavior for
- * calculating assignability between primitive and wrapper types <em>corresponding
- * to the running Java version</em>; i.e. autoboxing will be the default
- * behavior in VMs running Java versions > 1.5.</p>
+ * <p>
+ * <strong>Since Lang 3.0,</strong> this method will default behavior for calculating assignability between primitive
+ * and wrapper types <em>corresponding to the running Java version</em>; i.e. autoboxing will be the default behavior in
+ * VMs running Java versions > 1.5.
+ * </p>
*
- * @param cls the Class to check, may be null
- * @param toClass the Class to try to assign into, returns false if null
+ * @param cls the Class to check, may be null
+ * @param toClass the Class to try to assign into, returns false if null
* @return {@code true} if assignment possible
*/
public static boolean isAssignable(final Class<?> cls, final Class<?> toClass) {
@@ -1129,30 +1299,35 @@
}
/**
- * <p>Checks if one {@code Class} can be assigned to a variable of
- * another {@code Class}.</p>
+ * <p>
+ * Checks if one {@code Class} can be assigned to a variable of another {@code Class}.
+ * </p>
*
- * <p>Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method,
- * this method takes into account widenings of primitive classes and
- * {@code null}s.</p>
+ * <p>
+ * Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method, this method takes into account widenings of
+ * primitive classes and {@code null}s.
+ * </p>
*
- * <p>Primitive widenings allow an int to be assigned to a long, float or
- * double. This method returns the correct result for these cases.</p>
+ * <p>
+ * Primitive widenings allow an int to be assigned to a long, float or double. This method returns the correct result
+ * for these cases.
+ * </p>
*
- * <p>{@code Null} may be assigned to any reference type. This method
- * will return {@code true} if {@code null} is passed in and the
- * toClass is non-primitive.</p>
+ * <p>
+ * {@code Null} may be assigned to any reference type. This method will return {@code true} if {@code null} is passed in
+ * and the toClass is non-primitive.
+ * </p>
*
- * <p>Specifically, this method tests whether the type represented by the
- * specified {@code Class} parameter can be converted to the type
- * represented by this {@code Class} object via an identity conversion
- * widening primitive or widening reference conversion. See
- * <em><a href="http://docs.oracle.com/javase/specs/">The Java Language Specification</a></em>,
- * sections 5.1.1, 5.1.2 and 5.1.4 for details.</p>
+ * <p>
+ * Specifically, this method tests whether the type represented by the specified {@code Class} parameter can be
+ * converted to the type represented by this {@code Class} object via an identity conversion widening primitive or
+ * widening reference conversion. See <em><a href="http://docs.oracle.com/javase/specs/">The Java Language
+ * Specification</a></em>, sections 5.1.1, 5.1.2 and 5.1.4 for details.
+ * </p>
*
- * @param cls the Class to check, may be null
- * @param toClass the Class to try to assign into, returns false if null
- * @param autoboxing whether to use implicit autoboxing/unboxing between primitives and wrappers
+ * @param cls the Class to check, may be null
+ * @param toClass the Class to try to assign into, returns false if null
+ * @param autoboxing whether to use implicit autoboxing/unboxing between primitives and wrappers
* @return {@code true} if assignment possible
*/
public static boolean isAssignable(Class<?> cls, final Class<?> toClass, final boolean autoboxing) {
@@ -1163,7 +1338,7 @@
if (cls == null) {
return !toClass.isPrimitive();
}
- //autoboxing:
+ // autoboxing:
if (autoboxing) {
if (cls.isPrimitive() && !toClass.isPrimitive()) {
cls = primitiveToWrapper(cls);
@@ -1186,13 +1361,10 @@
return false;
}
if (Integer.TYPE.equals(cls)) {
- return Long.TYPE.equals(toClass)
- || Float.TYPE.equals(toClass)
- || Double.TYPE.equals(toClass);
+ return Long.TYPE.equals(toClass) || Float.TYPE.equals(toClass) || Double.TYPE.equals(toClass);
}
if (Long.TYPE.equals(cls)) {
- return Float.TYPE.equals(toClass)
- || Double.TYPE.equals(toClass);
+ return Float.TYPE.equals(toClass) || Double.TYPE.equals(toClass);
}
if (Boolean.TYPE.equals(cls)) {
return false;
@@ -1204,22 +1376,13 @@
return Double.TYPE.equals(toClass);
}
if (Character.TYPE.equals(cls)) {
- return Integer.TYPE.equals(toClass)
- || Long.TYPE.equals(toClass)
- || Float.TYPE.equals(toClass)
- || Double.TYPE.equals(toClass);
+ return Integer.TYPE.equals(toClass) || Long.TYPE.equals(toClass) || Float.TYPE.equals(toClass) || Double.TYPE.equals(toClass);
}
if (Short.TYPE.equals(cls)) {
- return Integer.TYPE.equals(toClass)
- || Long.TYPE.equals(toClass)
- || Float.TYPE.equals(toClass)
- || Double.TYPE.equals(toClass);
+ return Integer.TYPE.equals(toClass) || Long.TYPE.equals(toClass) || Float.TYPE.equals(toClass) || Double.TYPE.equals(toClass);
}
if (Byte.TYPE.equals(cls)) {
- return Short.TYPE.equals(toClass)
- || Integer.TYPE.equals(toClass)
- || Long.TYPE.equals(toClass)
- || Float.TYPE.equals(toClass)
+ return Short.TYPE.equals(toClass) || Integer.TYPE.equals(toClass) || Long.TYPE.equals(toClass) || Float.TYPE.equals(toClass)
|| Double.TYPE.equals(toClass);
}
// should never get here
@@ -1229,39 +1392,46 @@
}
/**
- * <p>Checks if an array of Classes can be assigned to another array of Classes.</p>
+ * <p>
+ * Checks if an array of Classes can be assigned to another array of Classes.
+ * </p>
*
- * <p>This method calls {@link #isAssignable(Class, Class) isAssignable} for each
- * Class pair in the input arrays. It can be used to check if a set of arguments
- * (the first parameter) are suitably compatible with a set of method parameter types
- * (the second parameter).</p>
+ * <p>
+ * This method calls {@link #isAssignable(Class, Class) isAssignable} for each Class pair in the input arrays. It can be
+ * used to check if a set of arguments (the first parameter) are suitably compatible with a set of method parameter
+ * types (the second parameter).
+ * </p>
*
- * <p>Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method, this
- * method takes into account widenings of primitive classes and
- * {@code null}s.</p>
+ * <p>
+ * Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method, this method takes into account widenings of
+ * primitive classes and {@code null}s.
+ * </p>
*
- * <p>Primitive widenings allow an int to be assigned to a {@code long},
- * {@code float} or {@code double}. This method returns the correct
- * result for these cases.</p>
+ * <p>
+ * Primitive widenings allow an int to be assigned to a {@code long}, {@code float} or {@code double}. This method
+ * returns the correct result for these cases.
+ * </p>
*
- * <p>{@code Null} may be assigned to any reference type. This method will
- * return {@code true} if {@code null} is passed in and the toClass is
- * non-primitive.</p>
+ * <p>
+ * {@code Null} may be assigned to any reference type. This method will return {@code true} if {@code null} is passed in
+ * and the toClass is non-primitive.
+ * </p>
*
- * <p>Specifically, this method tests whether the type represented by the
- * specified {@code Class} parameter can be converted to the type
- * represented by this {@code Class} object via an identity conversion
- * widening primitive or widening reference conversion. See
- * <em><a href="http://docs.oracle.com/javase/specs/">The Java Language Specification</a></em>,
- * sections 5.1.1, 5.1.2 and 5.1.4 for details.</p>
+ * <p>
+ * Specifically, this method tests whether the type represented by the specified {@code Class} parameter can be
+ * converted to the type represented by this {@code Class} object via an identity conversion widening primitive or
+ * widening reference conversion. See <em><a href="http://docs.oracle.com/javase/specs/">The Java Language
+ * Specification</a></em>, sections 5.1.1, 5.1.2 and 5.1.4 for details.
+ * </p>
*
- * <p><strong>Since Lang 3.0,</strong> this method will default behavior for
- * calculating assignability between primitive and wrapper types <em>corresponding
- * to the running Java version</em>; i.e. autoboxing will be the default
- * behavior in VMs running Java versions > 1.5.</p>
+ * <p>
+ * <strong>Since Lang 3.0,</strong> this method will default behavior for calculating assignability between primitive
+ * and wrapper types <em>corresponding to the running Java version</em>; i.e. autoboxing will be the default behavior in
+ * VMs running Java versions > 1.5.
+ * </p>
*
- * @param classArray the array of Classes to check, may be {@code null}
- * @param toClassArray the array of Classes to try to assign into, may be {@code null}
+ * @param classArray the array of Classes to check, may be {@code null}
+ * @param toClassArray the array of Classes to try to assign into, may be {@code null}
* @return {@code true} if assignment possible
*/
public static boolean isAssignable(final Class<?>[] classArray, final Class<?>... toClassArray) {
@@ -1269,35 +1439,41 @@
}
/**
- * <p>Checks if an array of Classes can be assigned to another array of Classes.</p>
+ * <p>
+ * Checks if an array of Classes can be assigned to another array of Classes.
+ * </p>
*
- * <p>This method calls {@link #isAssignable(Class, Class) isAssignable} for each
- * Class pair in the input arrays. It can be used to check if a set of arguments
- * (the first parameter) are suitably compatible with a set of method parameter types
- * (the second parameter).</p>
+ * <p>
+ * This method calls {@link #isAssignable(Class, Class) isAssignable} for each Class pair in the input arrays. It can be
+ * used to check if a set of arguments (the first parameter) are suitably compatible with a set of method parameter
+ * types (the second parameter).
+ * </p>
*
- * <p>Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method, this
- * method takes into account widenings of primitive classes and
- * {@code null}s.</p>
+ * <p>
+ * Unlike the {@link Class#isAssignableFrom(java.lang.Class)} method, this method takes into account widenings of
+ * primitive classes and {@code null}s.
+ * </p>
*
- * <p>Primitive widenings allow an int to be assigned to a {@code long},
- * {@code float} or {@code double}. This method returns the correct
- * result for these cases.</p>
+ * <p>
+ * Primitive widenings allow an int to be assigned to a {@code long}, {@code float} or {@code double}. This method
+ * returns the correct result for these cases.
+ * </p>
*
- * <p>{@code Null} may be assigned to any reference type. This method will
- * return {@code true} if {@code null} is passed in and the toClass is
- * non-primitive.</p>
+ * <p>
+ * {@code Null} may be assigned to any reference type. This method will return {@code true} if {@code null} is passed in
+ * and the toClass is non-primitive.
+ * </p>
*
- * <p>Specifically, this method tests whether the type represented by the
- * specified {@code Class} parameter can be converted to the type
- * represented by this {@code Class} object via an identity conversion
- * widening primitive or widening reference conversion. See
- * <em><a href="http://docs.oracle.com/javase/specs/">The Java Language Specification</a></em>,
- * sections 5.1.1, 5.1.2 and 5.1.4 for details.</p>
+ * <p>
+ * Specifically, this method tests whether the type represented by the specified {@code Class} parameter can be
+ * converted to the type represented by this {@code Class} object via an identity conversion widening primitive or
+ * widening reference conversion. See <em><a href="http://docs.oracle.com/javase/specs/">The Java Language
+ * Specification</a></em>, sections 5.1.1, 5.1.2 and 5.1.4 for details.
+ * </p>
*
- * @param classArray the array of Classes to check, may be {@code null}
- * @param toClassArray the array of Classes to try to assign into, may be {@code null}
- * @param autoboxing whether to use implicit autoboxing/unboxing between primitives and wrappers
+ * @param classArray the array of Classes to check, may be {@code null}
+ * @param toClassArray the array of Classes to try to assign into, may be {@code null}
+ * @param autoboxing whether to use implicit autoboxing/unboxing between primitives and wrappers
* @return {@code true} if assignment possible
*/
public static boolean isAssignable(Class<?>[] classArray, Class<?>[] toClassArray, final boolean autoboxing) {
@@ -1319,24 +1495,24 @@
}
/**
- * <p>Is the specified class an inner class or static nested class.</p>
+ * <p>
+ * Is the specified class an inner class or static nested class.
+ * </p>
*
- * @param cls the class to check, may be null
- * @return {@code true} if the class is an inner or static nested class,
- * false if not or {@code null}
+ * @param cls the class to check, may be null
+ * @return {@code true} if the class is an inner or static nested class, false if not or {@code null}
*/
public static boolean isInnerClass(final Class<?> cls) {
return cls != null && cls.getEnclosingClass() != null;
}
/**
- * Returns whether the given {@code type} is a primitive or primitive wrapper ({@link Boolean}, {@link Byte}, {@link Character},
- * {@link Short}, {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
+ * Returns whether the given {@code type} is a primitive or primitive wrapper ({@link Boolean}, {@link Byte},
+ * {@link Character}, {@link Short}, {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
*
- * @param type
- * The class to query or null.
- * @return true if the given {@code type} is a primitive or primitive wrapper ({@link Boolean}, {@link Byte}, {@link Character},
- * {@link Short}, {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
+ * @param type The class to query or null.
+ * @return true if the given {@code type} is a primitive or primitive wrapper ({@link Boolean}, {@link Byte},
+ * {@link Character}, {@link Short}, {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
* @since 3.1
*/
public static boolean isPrimitiveOrWrapper(final Class<?> type) {
@@ -1347,13 +1523,12 @@
}
/**
- * Returns whether the given {@code type} is a primitive wrapper ({@link Boolean}, {@link Byte}, {@link Character}, {@link Short},
- * {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
+ * Returns whether the given {@code type} is a primitive wrapper ({@link Boolean}, {@link Byte}, {@link Character},
+ * {@link Short}, {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
*
- * @param type
- * The class to query or null.
- * @return true if the given {@code type} is a primitive wrapper ({@link Boolean}, {@link Byte}, {@link Character}, {@link Short},
- * {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
+ * @param type The class to query or null.
+ * @return true if the given {@code type} is a primitive wrapper ({@link Boolean}, {@link Byte}, {@link Character},
+ * {@link Short}, {@link Integer}, {@link Long}, {@link Double}, {@link Float}).
* @since 3.1
*/
public static boolean isPrimitiveWrapper(final Class<?> type) {
@@ -1361,13 +1536,13 @@
}
/**
- * <p>Converts the specified array of primitive Class objects to an array of
- * its corresponding wrapper Class objects.</p>
+ * <p>
+ * Converts the specified array of primitive Class objects to an array of its corresponding wrapper Class objects.
+ * </p>
*
- * @param classes the class array to convert, may be null or empty
- * @return an array which contains for each given class, the wrapper class or
- * the original class if class is not a primitive. {@code null} if null input.
- * Empty array if an empty array passed in.
+ * @param classes the class array to convert, may be null or empty
+ * @return an array which contains for each given class, the wrapper class or the original class if class is not a
+ * primitive. {@code null} if null input. Empty array if an empty array passed in.
* @since 2.1
*/
public static Class<?>[] primitivesToWrappers(final Class<?>... classes) {
@@ -1387,15 +1562,17 @@
}
/**
- * <p>Converts the specified primitive Class object to its corresponding
- * wrapper Class object.</p>
+ * <p>
+ * Converts the specified primitive Class object to its corresponding wrapper Class object.
+ * </p>
*
- * <p>NOTE: From v2.2, this method handles {@code Void.TYPE},
- * returning {@code Void.TYPE}.</p>
+ * <p>
+ * NOTE: From v2.2, this method handles {@code Void.TYPE}, returning {@code Void.TYPE}.
+ * </p>
*
- * @param cls the class to convert, may be null
- * @return the wrapper class for {@code cls} or {@code cls} if
- * {@code cls} is not a primitive. {@code null} if null input.
+ * @param cls the class to convert, may be null
+ * @return the wrapper class for {@code cls} or {@code cls} if {@code cls} is not a primitive. {@code null} if null
+ * input.
* @since 2.1
*/
public static Class<?> primitiveToWrapper(final Class<?> cls) {
@@ -1409,7 +1586,7 @@
/**
* Converts a class name to a JLS style class name.
*
- * @param className the class name
+ * @param className the class name
* @return the converted name
*/
private static String toCanonicalName(String className) {
@@ -1433,10 +1610,14 @@
}
/**
- * <p>Converts an array of {@code Object} in to an array of {@code Class} objects.
- * If any of these objects is null, a null element will be inserted into the array.</p>
+ * <p>
+ * Converts an array of {@code Object} in to an array of {@code Class} objects. If any of these objects is null, a null
+ * element will be inserted into the array.
+ * </p>
*
- * <p>This method returns {@code null} for a {@code null} input array.</p>
+ * <p>
+ * This method returns {@code null} for a {@code null} input array.
+ * </p>
*
* @param array an {@code Object} array
* @return a {@code Class} array, {@code null} if null array input
@@ -1457,52 +1638,44 @@
}
/**
- * <p>Decides if the part that was just copied to its destination
- * location in the work array can be kept as it was copied or must be
- * abbreviated. It must be kept when the part is the last one, which
- * is the simple name of the class. In this case the {@code source}
- * index, from where the characters are copied points one position
- * after the last character, a.k.a. {@code source ==
- * originalLength}</p>
+ * <p>
+ * Decides if the part that was just copied to its destination location in the work array can be kept as it was copied
+ * or must be abbreviated. It must be kept when the part is the last one, which is the simple name of the class. In this
+ * case the {@code source} index, from where the characters are copied points one position after the last character,
+ * a.k.a. {@code source ==
+ * originalLength}
+ * </p>
*
- * <p>If the part is not the last one then it can be kept
- * unabridged if the number of the characters copied so far plus
- * the character that are to be copied is less than or equal to the
- * desired length.</p>
+ * <p>
+ * If the part is not the last one then it can be kept unabridged if the number of the characters copied so far plus the
+ * character that are to be copied is less than or equal to the desired length.
+ * </p>
*
- * @param runAheadTarget the target index (where the characters were
- * copied to) pointing after the last character
- * copied when the current part was copied
- * @param source the source index (where the characters were
- * copied from) pointing after the last
- * character copied when the current part was
- * copied
- * @param originalLength the original length of the class full name,
- * which is abbreviated
- * @param desiredLength the desired length of the abbreviated class
- * name
- * @return {@code true} if it can be kept in its original length
- * {@code false} if the current part has to be abbreviated and
+ * @param runAheadTarget the target index (where the characters were copied to) pointing after the last character copied
+ * when the current part was copied
+ * @param source the source index (where the characters were copied from) pointing after the last character copied when
+ * the current part was copied
+ * @param originalLength the original length of the class full name, which is abbreviated
+ * @param desiredLength the desired length of the abbreviated class name
+ * @return {@code true} if it can be kept in its original length {@code false} if the current part has to be abbreviated
+ * and
*/
- private static boolean useFull(final int runAheadTarget,
- final int source,
- final int originalLength,
- final int desiredLength) {
- return source >= originalLength ||
- runAheadTarget + originalLength - source <= desiredLength;
+ private static boolean useFull(final int runAheadTarget, final int source, final int originalLength, final int desiredLength) {
+ return source >= originalLength || runAheadTarget + originalLength - source <= desiredLength;
}
/**
- * <p>Converts the specified array of wrapper Class objects to an array of
- * its corresponding primitive Class objects.</p>
+ * <p>
+ * Converts the specified array of wrapper Class objects to an array of its corresponding primitive Class objects.
+ * </p>
*
- * <p>This method invokes {@code wrapperToPrimitive()} for each element
- * of the passed in array.</p>
+ * <p>
+ * This method invokes {@code wrapperToPrimitive()} for each element of the passed in array.
+ * </p>
*
- * @param classes the class array to convert, may be null or empty
- * @return an array which contains for each given class, the primitive class or
- * <b>null</b> if the original class is not a wrapper class. {@code null} if null input.
- * Empty array if an empty array passed in.
+ * @param classes the class array to convert, may be null or empty
+ * @return an array which contains for each given class, the primitive class or <b>null</b> if the original class is not
+ * a wrapper class. {@code null} if null input. Empty array if an empty array passed in.
* @see #wrapperToPrimitive(Class)
* @since 2.4
*/
@@ -1523,18 +1696,18 @@
}
/**
- * <p>Converts the specified wrapper class to its corresponding primitive
- * class.</p>
+ * <p>
+ * Converts the specified wrapper class to its corresponding primitive class.
+ * </p>
*
- * <p>This method is the counter part of {@code primitiveToWrapper()}.
- * If the passed in class is a wrapper class for a primitive type, this
- * primitive type will be returned (e.g. {@code Integer.TYPE} for
- * {@code Integer.class}). For other classes, or if the parameter is
- * <b>null</b>, the return value is <b>null</b>.</p>
+ * <p>
+ * This method is the counter part of {@code primitiveToWrapper()}. If the passed in class is a wrapper class for a
+ * primitive type, this primitive type will be returned (e.g. {@code Integer.TYPE} for {@code Integer.class}). For other
+ * classes, or if the parameter is <b>null</b>, the return value is <b>null</b>.
+ * </p>
*
* @param cls the class to convert, may be <b>null</b>
- * @return the corresponding primitive type if {@code cls} is a
- * wrapper class, <b>null</b> otherwise
+ * @return the corresponding primitive type if {@code cls} is a wrapper class, <b>null</b> otherwise
* @see #primitiveToWrapper(Class)
* @since 2.4
*/
@@ -1543,12 +1716,14 @@
}
/**
- * <p>ClassUtils instances should NOT be constructed in standard programming.
- * Instead, the class should be used as
- * {@code ClassUtils.getShortClassName(cls)}.</p>
+ * <p>
+ * ClassUtils instances should NOT be constructed in standard programming. Instead, the class should be used as
+ * {@code ClassUtils.getShortClassName(cls)}.
+ * </p>
*
- * <p>This constructor is public to permit tools that require a JavaBean
- * instance to operate.</p>
+ * <p>
+ * This constructor is public to permit tools that require a JavaBean instance to operate.
+ * </p>
*/
public ClassUtils() {
}
diff --git a/src/test/java/org/apache/commons/lang3/ClassUtilsTest.java b/src/test/java/org/apache/commons/lang3/ClassUtilsTest.java
index 13620bf..d3caeb4 100644
--- a/src/test/java/org/apache/commons/lang3/ClassUtilsTest.java
+++ b/src/test/java/org/apache/commons/lang3/ClassUtilsTest.java
@@ -36,6 +36,7 @@
import java.util.List;
import java.util.Map;
import java.util.Set;
+import java.util.TreeMap;
import org.apache.commons.lang3.ClassUtils.Interfaces;
import org.apache.commons.lang3.reflect.testbed.GenericConsumer;
@@ -1138,6 +1139,24 @@
}
@Test
+ public void testComparable() {
+ final TreeMap<Class<?>, String> map = new TreeMap<>(ClassUtils.comparator());
+ map.put(String.class, "lastEntry");
+ map.toString();
+ map.put(Character.class, "firstEntry");
+ map.toString();
+ assertEquals("firstEntry", map.firstEntry().getValue());
+ assertEquals(Character.class, map.firstEntry().getKey());
+ //
+ assertEquals("lastEntry", map.lastEntry().getValue());
+ assertEquals(String.class, map.lastEntry().getKey());
+ //
+ map.put(null, "null");
+ map.toString();
+ assertEquals("null", map.get(null));
+ }
+
+ @Test
public void testConstructor() {
assertNotNull(new ClassUtils());
final Constructor<?>[] cons = ClassUtils.class.getDeclaredConstructors();
