org.apache.sis.util

Class Classes

Object

Static

Classes

public final class Classes
extends Static

Static methods working on Class objects. This class defines helper methods for working with reflection. Some functionalities are:

• Add or remove dimension to an array type (change­Array­Dimension)
• Find the common parent of two or more classes (find­Common­Class, find­Common­Interfaces)
• Getting the bounds of a parameterized field or method (bound­Of­Parameterized­Property)
• Getting a short class name (get­Short­Name, get­Short­Class­Name)

Since:

0.3

Defined in the sis-utility module

Method Summary

Modifier and Type	Method and Description
static Class<?>	bound­Of­Parameterized­Property(Field field) Returns the upper bounds of the parameterized type of the given property.
static Class<?>	bound­Of­Parameterized­Property(Method method) If the given method is a getter or a setter for a parameterized property, returns the upper bounds of the parameterized type.
static Class<?>	change­Array­Dimension(Class<?> element, int dimension) Changes the array dimension by the given amount.
static Class<?>	find­Common­Class(Class<?> c1, Class<?> c2) Returns the most specific class which is assignable from the given classes or a parent of those classes.
static Class<?>	find­Common­Class(Iterable<?> objects) Returns the most specific class which is assignable from the type of all given objects.
static Set<Class<?>>	find­Common­Interfaces(Class<?> c1, Class<?> c2) Returns the interfaces which are implemented by the two given classes.
static Class<?>	find­Specialized­Class(Iterable<?> objects) Returns the most specific class implemented by the objects in the given collection.
static <T> Class<? super T>[]	get­All­Interfaces(Class<T> type) Returns every interfaces implemented, directly or indirectly, by the given class or interface.
static <T> Class<? extends T>	get­Class(T object) Returns the class of the specified object, or null if object is null.
static <T> Class<? extends T>[]	get­Leaf­Interfaces(Class<?> type, Class<T> base­Interface) Returns the interfaces implemented by the given class and assignable to the given base interface, or an empty array if none.
static String	get­Short­Class­Name(Object object) Returns the class name of the given object without package name, but including the enclosing class names if any.
static String	get­Short­Name(Class<?> classe) Returns the name of the given class without package name, but including the names of enclosing classes if any.
static boolean	implement­Same­Interfaces(Class<?> object1, Class<?> object2, Class<?> base­Interface) Returns true if the two specified objects implements exactly the same set of interfaces.
static boolean	is­Assignable­To­Any(Class<?> type, Class<?>... allowed­Types) Returns true if the given type is assignable to one of the given allowed types.
static boolean	is­Possible­Getter(Method method) Returns true if the given method may possibly be the getter method for a property.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Method Detail

changeArrayDimension

public static Class<?> changeArrayDimension(Class<?> element,
                                            int dimension)

Changes the array dimension by the given amount. The given class can be a primitive type, a Java object, or an array of the above. If the given dimension is positive, then the array dimension will be increased by that amount. For example a change of dimension 1 will change a int class into int[], and a String[] class into String[][]. A change of dimension 2 is like applying a change of dimension 1 two times.

The change of dimension can also be negative. For example a change of dimension -1 will change a String[] class into a String. More specifically:

• If the given element is null, then this method returns null.
• Otherwise if the given dimension change is 0, then the given element is returned unchanged.
• Otherwise if the given dimension change is negative, then Class.get­Component­Type() is invoked abs(dimension) times. The result is a null value if abs(dimension) is greater than the array dimension.
• Otherwise if element is Void.TYPE, then this method returns Void.TYPE since arrays of void don't exist.
• Otherwise this method returns a class that represents an array of the given class augmented by the given amount of dimensions.

Parameters:

element - The type of elements in the array.

dimension - The change of dimension, as a negative or positive number.

Returns:

The type of an array of the given element type augmented by the given number of dimensions (which may be negative), or null.

boundOfParameterizedProperty

public static Class<?> boundOfParameterizedProperty(Field field)

Returns the upper bounds of the parameterized type of the given property. If the property does not have a parameterized type, returns null.

This method is typically used for fetching the type of elements in a collection. We do not provide a method working from a Class instance because of the way parameterized types are implemented in Java (by erasure).

Examples: When invoking this method for a field of the type below:

• Set<Number> returns Number.class.
• Set<? extends Number> returns Number.class as well, since that collection can not (in theory) contain instances of super-classes; Number is the upper bound.
• Set<? super Number> returns Object.class, because that collection is allowed to contain such elements.
• Set returns null because that collection is un-parameterized.

Parameters:

field - The field for which to obtain the parameterized type.

Returns:

The upper bound of parameterized type, or null if the given field is not of a parameterized type.

boundOfParameterizedProperty

public static Class<?> boundOfParameterizedProperty(Method method)

If the given method is a getter or a setter for a parameterized property, returns the upper bounds of the parameterized type. Otherwise returns null. This method provides the same semantic than bound­Of­Parameterized­Property(Field), but works on a getter or setter method rather then the field. See the javadoc of above method for more details.

This method is typically used for fetching the type of elements in a collection. We do not provide a method working from a Class instance because of the way parameterized types are implemented in Java (by erasure).

Parameters:

method - The getter or setter method for which to obtain the parameterized type.

Returns:

The upper bound of parameterized type, or null if the given method do not operate on an object of a parameterized type.

getClass

@Workaround(library="JDK",
            version="1.7")
public static <T> Class<? extends T> getClass(T object)

Returns the class of the specified object, or null if object is null. This method is also useful for fetching the class of an object known only by its bound type. As of Java 6, the usual pattern:

Number n = 0;
Class<? extends Number> c = n.getClass();

doesn't seem to work if Number is replaced by a parameterized type T.

Type Parameters:

T - The type of the given object.

Parameters:

object - The object for which to get the class, or null.

Returns:

The class of the given object, or null if the given object was null.

getAllInterfaces

public static <T> Class<? super T>[] getAllInterfaces(Class<T> type)

Returns every interfaces implemented, directly or indirectly, by the given class or interface. This is similar to Class.get­Interfaces() except that this method searches recursively in the super-interfaces. For example if the given type is Array­List, then the returned set will contains List (which is implemented directly) together with its parent interfaces Collection and Iterable.

Type Parameters:

T - The compile-time type of the Class argument.

Parameters:

type - The class or interface for which to get all implemented interfaces.

Returns:

All implemented interfaces (not including the given type if it was an interface), or an empty array if none.

See Also:

Class.get­Interfaces()

getLeafInterfaces

public static <T> Class<? extends T>[] getLeafInterfaces(Class<?> type,
                                                         Class<T> baseInterface)

Returns the interfaces implemented by the given class and assignable to the given base interface, or an empty array if none. If more than one interface extends the given base, then the most specialized interfaces are returned. For example if the given class implements both the Set and Collection interfaces, then the returned array contains only the Set interface.

Example

get­Leaf­Interfaces(Array­List.class, Collection.class) returns an array of length 1 containing List.class.

Type Parameters:

T - The type of the base­Interface class argument.

Parameters:

type - A class for which the implemented interfaces are desired.

base­Interface - The base type of the interfaces to search.

Returns:

The leaf interfaces matching the given criterion, or an empty array if none.

findSpecializedClass

public static Class<?> findSpecializedClass(Iterable<?> objects)

Returns the most specific class implemented by the objects in the given collection. If there is more than one specialized class, returns their most specific common super class.

This method searches for classes only, not interfaces.

Parameters:

objects - A collection of objects. May contains duplicated values and null values.

Returns:

The most specialized class, or null if the given collection does not contain at least one non-null element.

findCommonClass

public static Class<?> findCommonClass(Iterable<?> objects)

Returns the most specific class which is assignable from the type of all given objects. If no element in the given collection has a type assignable from the type of all other elements, then this method searches for a common super class.

This method searches for classes only, not interfaces.

Parameters:

objects - A collection of objects. May contains duplicated values and null values.

Returns:

The most specific class common to all supplied objects, or null if the given collection does not contain at least one non-null element.

findCommonClass

public static Class<?> findCommonClass(Class<?> c1,
                                       Class<?> c2)

Returns the most specific class which is assignable from the given classes or a parent of those classes. This method returns either c1, c2 or a common parent of c1 and c2.

This method considers classes only, not the interfaces.

Parameters:

c1 - The first class, or null.

c2 - The second class, or null.

Returns:

The most specific class common to the supplied classes, or null if both c1 and c2 are null.

findCommonInterfaces

public static Set<Class<?>> findCommonInterfaces(Class<?> c1,
                                                 Class<?> c2)

Returns the interfaces which are implemented by the two given classes. The returned set does not include the parent interfaces. For example if the two given objects implement the Collection interface, then the returned set will contains the Collection type but not the Iterable type, since it is implied by the collection type.

Parameters:

c1 - The first class.

c2 - The second class.

Returns:

The interfaces common to both classes, or an empty set if none. Callers can freely modify the returned set.

implementSameInterfaces

public static boolean implementSameInterfaces(Class<?> object1,
                                              Class<?> object2,
                                              Class<?> baseInterface)

Returns true if the two specified objects implements exactly the same set of interfaces. Only interfaces assignable to base­Interface are compared. Declaration order doesn't matter.

Example: in ISO 19111, different interfaces exist for different coordinate system (CS) geometries (Cartesian­CS, Polar­CS, etc.). One can check if two implementations have the same geometry with the following code:

if (implementSameInterfaces(cs1, cs2, CoordinateSystem.class)) {
    // The two Coordinate System are of the same kind.
}

Parameters:

object1 - The first object to check for interfaces.

object2 - The second object to check for interfaces.

base­Interface - The parent of all interfaces to check.

Returns:

true if both objects implement the same set of interfaces, considering only sub-interfaces of base­Interface.

getShortName

public static String getShortName(Class<?> classe)

Returns the name of the given class without package name, but including the names of enclosing classes if any. This method is similar to the Class.get­Simple­Name() method, except that if the given class is an inner class, then the returned value is prefixed with the outer class name. An other difference is that if the given class is local or anonymous, then this method returns the name of the parent class.

The following table compares the various kind of names for some examples:

Class name comparisons

Class	get­Name()	get­Simple­Name()	get­Canonical­Name()	get­Short­Name()
String	"java.lang.String"	"String"	"java.lang.String"	"String"
double[]	"[D"	"double[]"	"double[]"	"double[]"
Point2D.Double	"java.awt.geom.Point2D$Double"	"Double"	"java.awt.geom.Point2D.Double"	"Point2D.Double"
Anonymous Comparable	"com.mycompany.myclass$1"	""	null	"Object"

Parameters:

classe - The object class (may be null).

Returns:

The simple name with outer class name (if any) of the first non-anonymous class in the hierarchy, or "<*>" if the given class is null.

See Also:

get­Short­Class­Name(Object), Class.get­Simple­Name()

getShortClassName

public static String getShortClassName(Object object)

Returns the class name of the given object without package name, but including the enclosing class names if any. Invoking this method is equivalent to invoking get­Short­Name(object.get­Class()) except for null value. See get­Short­Name(Class) for more information on the class name returned by this method.

Parameters:

object - The object (may be null).

Returns:

The simple class name with outer class name (if any) of the first non-anonymous class in the hierarchy, or "<*>" if the given object is null.

See Also:

get­Short­Name(Class)

isAssignableToAny

public static boolean isAssignableToAny(Class<?> type,
                                        Class<?>... allowedTypes)

Returns true if the given type is assignable to one of the given allowed types. More specifically, if at least one allowed­Types[i] element exists for which allowed­Types[i].is­Assignable­From(type) returns true, then this method returns true.

Special cases:

• If type is null, then this method returns false.
• If allowed­Types is null, then this method returns true. This is to be interpreted as "no restriction on the allowed types".
• Any null element in the allowed­Types array are silently ignored.

Parameters:

type - The type to be tested, or null.

allowed­Types - The allowed types.

Returns:

true if the given type is assignable to one of the allowed types.

isPossibleGetter

public static boolean isPossibleGetter(Method method)

Returns true if the given method may possibly be the getter method for a property. This method implements the algorithm used by SIS in order to identify getter methods in metadata interfaces. We do not rely on naming convention (method names starting with "get" or "is" prefixes) because not every methods follow such convention (e.g. Conformance­Result.pass()).

The current implementation returns true if the given method meets all the following conditions. Note that a true value is not a guaranteed that the given method is really a getter. The caller is encouraged to perform additional checks if possible.

• The method does no expect any argument.
• The method returns a value (anything except void).
• The method name is not clone, get­Class, hash­Code, to­String or to­WKT.
• The method is not synthetic.

Those conditions may be updated in any future SIS version.

Parameters:

method - The method to inspect.

Returns:

true if the given method may possibly be a non-deprecated getter method.