ClassUtils (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.util.ClassUtils

```
public final class ClassUtils
extends Object
```
Useful methods for working with Class objects and primitive types.

Author:

Curtis Rueden

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`cacheAnnotatedObjects(Class<?> scannedClass, Query query)` This method scans the provided class, its superclasses and interfaces for all supported `Annotation` : `AnnotatedElement` pairs.
`static boolean`	`canCast(Class<?> c, Class<?> type)` Deprecated. use `Types.isAssignable(Type, Type)`
`static boolean`	`canCast(Object obj, Class<?> type)` Deprecated. use `Types.isInstance(Object, Class)`
`static boolean`	`canConvert(Class<?> c, Class<?> type)` Deprecated. use `ConversionUtils.canConvert(Class, Class)`
`static boolean`	`canConvert(Object value, Class<?> type)` Deprecated. use `ConversionUtils.canConvert(Object, Class)`
`static <T> T`	`cast(Object obj, Class<T> type)` Deprecated. use `Types.cast(Object, Class)`
`static int`	`compare(Class<?> c1, Class<?> c2)` Compares two `Class` objects using their fully qualified names.
`static <T> T`	`convert(Object value, Class<T> type)` Deprecated. use `ConversionUtils.convert(Object, Class)`
`static <A extends Annotation> List<Field>`	`getAnnotatedFields(Class<?> c, Class<A> annotationClass)` Gets the given class's `Field`s marked with the annotation of the specified class.
`static <A extends Annotation> void`	`getAnnotatedFields(Class<?> c, Class<A> annotationClass, List<Field> fields)` Gets the given class's `Field`s marked with the annotation of the specified class.
`static <A extends Annotation> List<Method>`	`getAnnotatedMethods(Class<?> c, Class<A> annotationClass)` Gets the given class's `Method`s marked with the annotation of the specified class.
`static <A extends Annotation> void`	`getAnnotatedMethods(Class<?> c, Class<A> annotationClass, List<Method> methods)` Gets the given class's `Method`s marked with the annotation of the specified class.
`static Class<?>`	`getArrayClass(Class<?> elementClass)` Deprecated. Use `Types.array(Class)` instead.
`static Field`	`getField(Class<?> c, String fieldName)` Deprecated. Use `Types.field(java.lang.Class<?>, java.lang.String)` instead.
`static Field`	`getField(String className, String fieldName)` Deprecated. Use `Types.field(java.lang.Class<?>, java.lang.String)` instead.
`static Type`	`getGenericType(Field field, Class<?> type)` Deprecated. Use `Types.fieldType(Field, Class)` instead.
`static URL`	`getLocation(Class<?> c)` Deprecated. Use `Types.location(java.lang.Class<?>)` and `Types.load(java.lang.String)` instead.
`static URL`	`getLocation(String className)` Deprecated. Use `Types.location(java.lang.Class<?>)` and `Types.load(java.lang.String)` instead.
`static URL`	`getLocation(String className, ClassLoader classLoader)` Deprecated. Use `Types.location(java.lang.Class<?>)` and `Types.load(java.lang.String)` instead.
`static <T> Class<T>`	`getNonprimitiveType(Class<T> type)` Deprecated. use `Types.box(Class)`
`static <T> T`	`getNullValue(Class<T> type)` Deprecated. use `Types.nullValue(Class)`
`static List<Class<?>>`	`getTypes(Field field, Class<?> type)` Deprecated. Use `Types.fieldType(Field, Class)` and `Types.raws(java.lang.reflect.Type)` instead.
`static Object`	`getValue(Field field, Object instance)` Gets the given field's value of the specified object instance, or null if the value cannot be obtained.
`static boolean`	`hasClass(String className)` Deprecated. Use `Types.load(String)` instead.
`static boolean`	`hasClass(String className, ClassLoader classLoader)` Deprecated. Use `Types.load(String, ClassLoader)` instead.
`static boolean`	`isBoolean(Class<?> type)` Deprecated. Use `Types.isBoolean(java.lang.Class<?>)` instead.
`static boolean`	`isByte(Class<?> type)` Deprecated. Use `Types.isByte(java.lang.Class<?>)` instead.
`static boolean`	`isCharacter(Class<?> type)` Deprecated. Use `Types.isCharacter(java.lang.Class<?>)` instead.
`static boolean`	`isDouble(Class<?> type)` Deprecated. Use `Types.isDouble(java.lang.Class<?>)` instead.
`static boolean`	`isFloat(Class<?> type)` Deprecated. Use `Types.isFloat(java.lang.Class<?>)` instead.
`static boolean`	`isInteger(Class<?> type)` Deprecated. Use `Types.isInteger(java.lang.Class<?>)` instead.
`static boolean`	`isLong(Class<?> type)` Deprecated. Use `Types.isLong(java.lang.Class<?>)` instead.
`static boolean`	`isNumber(Class<?> type)` Deprecated. Use `Types.isNumber(java.lang.Class<?>)` instead.
`static boolean`	`isShort(Class<?> type)` Deprecated. Use `Types.isShort(java.lang.Class<?>)` instead.
`static boolean`	`isText(Class<?> type)` Deprecated. Use `Types.isText(java.lang.Class<?>)` instead.
`static Class<?>`	`loadClass(String name)` Deprecated. Use `Types.load(String)` instead.
`static Class<?>`	`loadClass(String className, boolean quietly)` Deprecated. Use `Types.load(String, boolean)` instead.
`static Class<?>`	`loadClass(String name, ClassLoader classLoader)` Deprecated. Use `Types.load(String, ClassLoader)` instead.
`static Class<?>`	`loadClass(String name, ClassLoader classLoader, boolean quietly)` Deprecated. Use `Types.load(String, ClassLoader, boolean)` instead.
`static void`	`setValue(Field field, Object instance, Object value)` Sets the given field's value of the specified object instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAnnotatedMethods
```
public static <A extends Annotation> List<Method> getAnnotatedMethods(Class<?> c,
                                                                      Class<A> annotationClass)
```
Gets the given class's Methods marked with the annotation of the specified class.
Unlike Class.getMethods(), the result will include any non-public methods, including methods defined in supertypes of the given class.

Parameters:

c - The class to scan for annotated methods.

annotationClass - The type of annotation for which to scan.

Returns:

A list containing all methods with the requested annotation. Note that for performance reasons, lists may be cached and reused, so it is best to make a copy of the result if you need to modify it.

getAnnotatedMethods
```
public static <A extends Annotation> void getAnnotatedMethods(Class<?> c,
                                                              Class<A> annotationClass,
                                                              List<Method> methods)
```
Gets the given class's Methods marked with the annotation of the specified class.
Unlike Class.getMethods(), the result will include any non-public methods, including methods defined in supertypes of the given class.

Parameters:

c - The class to scan for annotated methods.

annotationClass - The type of annotation for which to scan.

methods - The list to which matching methods will be added.

getAnnotatedFields
```
public static <A extends Annotation> List<Field> getAnnotatedFields(Class<?> c,
                                                                    Class<A> annotationClass)
```
Gets the given class's Fields marked with the annotation of the specified class.
Unlike Class.getFields(), the result will include any non-public fields, including fields defined in supertypes of the given class.

Parameters:

c - The class to scan for annotated fields.

annotationClass - The type of annotation for which to scan.

Returns:

A list containing all fields with the requested annotation. Note that for performance reasons, lists may be cached and reused, so it is best to make a copy of the result if you need to modify it.

getAnnotatedFields
```
public static <A extends Annotation> void getAnnotatedFields(Class<?> c,
                                                             Class<A> annotationClass,
                                                             List<Field> fields)
```
Gets the given class's Fields marked with the annotation of the specified class.
Unlike Class.getFields(), the result will include any non-public fields, including fields defined in supertypes of the given class.

Parameters:

c - The class to scan for annotated fields.

annotationClass - The type of annotation for which to scan.

fields - The list to which matching fields will be added.

cacheAnnotatedObjects
```
public static void cacheAnnotatedObjects(Class<?> scannedClass,
                                         Query query)
```
This method scans the provided class, its superclasses and interfaces for all supported Annotation : AnnotatedElement pairs. These are then cached to remove the need for future queries.
By combining multiple Annotation : AnnotatedElement pairs in one query, we can limit the number of times a class's superclass and interface hierarchy are traversed.

Parameters:

scannedClass - Class to scan

query - Pairs of Annotation and AnnotatedElements to discover.

getValue

public static Object getValue(Field field,
                              Object instance)

Gets the given field's value of the specified object instance, or null if the value cannot be obtained.

setValue

public static void setValue(Field field,
                            Object instance,
                            Object value)

Sets the given field's value of the specified object instance.

Throws:: IllegalArgumentException - if the value cannot be set.

compare
```
public static int compare(Class<?> c1,
                          Class<?> c2)
```
Compares two Class objects using their fully qualified names.
Note: this method provides a natural ordering that may be inconsistent with equals. Specifically, two unequal classes may return 0 when compared in this fashion if they represent the same class loaded using two different ClassLoaders. Hence, if this method is used as a basis for implementing Comparable.compareTo(T) or Comparator.compare(T, T), that implementation may want to impose logic beyond that of this method, for breaking ties, if a total ordering consistent with equals is always required.

See Also:

Priority.compare(org.scijava.Prioritized, org.scijava.Prioritized)

loadClass

@Deprecated
public static Class<?> loadClass(String name)

Deprecated. Use Types.load(String) instead.

loadClass

@Deprecated
public static Class<?> loadClass(String name,
                                             ClassLoader classLoader)

Deprecated. Use Types.load(String, ClassLoader) instead.

loadClass

@Deprecated
public static Class<?> loadClass(String className,
                                             boolean quietly)

Deprecated. Use Types.load(String, boolean) instead.

loadClass

@Deprecated
public static Class<?> loadClass(String name,
                                             ClassLoader classLoader,
                                             boolean quietly)

Deprecated. Use Types.load(String, ClassLoader, boolean) instead.

hasClass

@Deprecated
public static boolean hasClass(String className)

Deprecated. Use Types.load(String) instead.

hasClass

@Deprecated
public static boolean hasClass(String className,
                                           ClassLoader classLoader)

Deprecated. Use Types.load(String, ClassLoader) instead.

getLocation
```
@Deprecated
public static URL getLocation(String className)
```
Deprecated. Use Types.location(java.lang.Class<?>) and Types.load(java.lang.String) instead.

getLocation

@Deprecated
public static URL getLocation(String className,
                                          ClassLoader classLoader)

Deprecated. Use Types.location(java.lang.Class<?>) and Types.load(java.lang.String) instead.

getLocation
```
@Deprecated
public static URL getLocation(Class<?> c)
```
Deprecated. Use Types.location(java.lang.Class<?>) and Types.load(java.lang.String) instead.

isBoolean
```
@Deprecated
public static boolean isBoolean(Class<?> type)
```
Deprecated. Use Types.isBoolean(java.lang.Class<?>) instead.

isByte
```
@Deprecated
public static boolean isByte(Class<?> type)
```
Deprecated. Use Types.isByte(java.lang.Class<?>) instead.

isCharacter
```
@Deprecated
public static boolean isCharacter(Class<?> type)
```
Deprecated. Use Types.isCharacter(java.lang.Class<?>) instead.

isDouble
```
@Deprecated
public static boolean isDouble(Class<?> type)
```
Deprecated. Use Types.isDouble(java.lang.Class<?>) instead.

isFloat
```
@Deprecated
public static boolean isFloat(Class<?> type)
```
Deprecated. Use Types.isFloat(java.lang.Class<?>) instead.

isInteger
```
@Deprecated
public static boolean isInteger(Class<?> type)
```
Deprecated. Use Types.isInteger(java.lang.Class<?>) instead.

isLong
```
@Deprecated
public static boolean isLong(Class<?> type)
```
Deprecated. Use Types.isLong(java.lang.Class<?>) instead.

isShort
```
@Deprecated
public static boolean isShort(Class<?> type)
```
Deprecated. Use Types.isShort(java.lang.Class<?>) instead.

isNumber
```
@Deprecated
public static boolean isNumber(Class<?> type)
```
Deprecated. Use Types.isNumber(java.lang.Class<?>) instead.

isText
```
@Deprecated
public static boolean isText(Class<?> type)
```
Deprecated. Use Types.isText(java.lang.Class<?>) instead.

convert

@Deprecated
public static <T> T convert(Object value,
                                        Class<T> type)

Deprecated. use ConversionUtils.convert(Object, Class)

canConvert

@Deprecated
public static boolean canConvert(Class<?> c,
                                             Class<?> type)

Deprecated. use ConversionUtils.canConvert(Class, Class)

canConvert

@Deprecated
public static boolean canConvert(Object value,
                                             Class<?> type)

Deprecated. use ConversionUtils.canConvert(Object, Class)

cast

@Deprecated
public static <T> T cast(Object obj,
                                     Class<T> type)

Deprecated. use Types.cast(Object, Class)

canCast

@Deprecated
public static boolean canCast(Class<?> c,
                                          Class<?> type)

Deprecated. use Types.isAssignable(Type, Type)

canCast

@Deprecated
public static boolean canCast(Object obj,
                                          Class<?> type)

Deprecated. use Types.isInstance(Object, Class)

getNonprimitiveType

@Deprecated
public static <T> Class<T> getNonprimitiveType(Class<T> type)

Deprecated. use Types.box(Class)

getNullValue

@Deprecated
public static <T> T getNullValue(Class<T> type)

Deprecated. use Types.nullValue(Class)

getTypes

@Deprecated
public static List<Class<?>> getTypes(Field field,
                                                  Class<?> type)

Deprecated. Use Types.fieldType(Field, Class) and Types.raws(java.lang.reflect.Type) instead.

getGenericType

@Deprecated
public static Type getGenericType(Field field,
                                              Class<?> type)

Deprecated. Use Types.fieldType(Field, Class) instead.

getField

@Deprecated
public static Field getField(String className,
                                         String fieldName)

Deprecated. Use Types.field(java.lang.Class<?>, java.lang.String) instead.

getField

@Deprecated
public static Field getField(Class<?> c,
                                         String fieldName)

Deprecated. Use Types.field(java.lang.Class<?>, java.lang.String) instead.

getArrayClass

@Deprecated
public static Class<?> getArrayClass(Class<?> elementClass)

Deprecated. Use Types.array(Class) instead.

Class ClassUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAnnotatedMethods

getAnnotatedMethods

getAnnotatedFields

getAnnotatedFields

cacheAnnotatedObjects

getValue

setValue

compare

loadClass

loadClass

loadClass

loadClass

hasClass

hasClass

getLocation

getLocation

getLocation

isBoolean

isByte

isCharacter

isDouble

isFloat

isInteger

isLong

isShort

isNumber

isText

convert

canConvert

canConvert

cast

canCast

canCast

getNonprimitiveType

getNullValue

getTypes

getGenericType

getField

getField

getArrayClass