MetadataReflectionUtils (java-utils 1.1.0 API)

java.lang.Object
- pl.jalokim.utils.reflection.MetadataReflectionUtils

public final class MetadataReflectionUtils
extends Object

Gather some metadata about classes.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Set<Class<? extends T>>`	`getAllChildClassesForClass(Class<T> superType, String packageDefinition, boolean withAbstractClasses)` It will search for all classes which inherit from provided super type.
`static Class<?>`	`getClassForName(String className)` It returns raw class, under the hood is used apache lang3.
`static Field`	`getField(Class<?> targetClass, String fieldName)` Returns lang.reflect.Field for given target class and fieldName.
`static Field`	`getField(Object targetObject, String fieldName)` Returns lang.reflect.Field for given target object and fieldName.
`static Method`	`getMethod(Class<?> targetClass, String methodName, Class<?>... argClasses)` It returns method for given target object.
`static Method`	`getMethod(Object targetObject, String methodName, Class<?>... argClasses)` It returns method for given target object.
`static List<Type>`	`getParametrizedRawTypes(Class<?> someClass)` It returns some parametrized types for given class.
`static Class<?>`	`getParametrizedType(Class<?> originalClass, int index)` It returns a type of generic class by given index.
`static Class<?>`	`getParametrizedType(Field field, int index)` It returns a type of generic field by given index.
`static Class<?>`	`getParametrizedType(Object targetObject, int index)` It returns a type of generic object by given index.
`static TypeMetadata`	`getTypeMetadataFromClass(Class<?> someClass)` It builds metadata for provided class.
`static TypeMetadata`	`getTypeMetadataFromField(Field field)` It build metadata from provided field but field needs to have all generic types as real classes.
`static TypeMetadata`	`getTypeMetadataFromField(Field field, int index)` It returns generic type from certain field by index.
`static TypeMetadata`	`getTypeMetadataFromType(Type type)` It build metadata from simple type.
`static TypeMetadata`	`getTypeMetadataOfArray(Field field)` It returns metadata of type stored in field which is array type.
`static Class<?>`	`getTypeOfArrayField(Field field)` Return type of field which is expected to be array field.
`static boolean`	`isArrayType(Class<?> someClass)` It checks that given class is array type.
`static boolean`	`isArrayType(Field field)` It checks that given field is array type.
`static boolean`	`isCollectionType(Class<?> someClass)` It checks that given class is collection type.
`static boolean`	`isCollectionType(Field field)` It checks that given field is collection type.
`static boolean`	`isEnumType(Class<?> someClass)` It checks that given class is simple enum type.
`static boolean`	`isEnumType(Field field)` It checks that given field is simple enum type.
`static boolean`	`isHavingElementsType(Class<?> someClass)` It checks that given class is array or collection type.
`static boolean`	`isHavingElementsType(Field field)` It checks that given field is array or collection type.
`static boolean`	`isMapType(Class<?> someClass)` It checks that given class is map type.
`static boolean`	`isMapType(Field field)` It checks that given field is map type.
`static boolean`	`isNumberType(Class<?> someClass)` It checks that given class is number type.
`static boolean`	`isNumberType(Field field)` It checks that given field is number type.
`static boolean`	`isSimpleType(Class<?> someClass)` It checks that given class is simple type.
`static boolean`	`isSimpleType(Field field)` It checks that given field is simple type.
`static boolean`	`isTextType(Class<?> someClass)` It checks that given class is simple string type.
`static boolean`	`isTextType(Field field)` It checks that given field is simple string type.

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

- Method Detail
  - getField
```
public static Field getField(Object targetObject,
                             String fieldName)
```
    Returns lang.reflect.Field for given target object and fieldName. It searches for first mach field in class hierarchy.
    
    Parameters:
    
    targetObject - object from which we will start searching.
    
    fieldName - name of object property.
    
    Returns:
    
    instance of Field.
  - getField
```
public static Field getField(Class<?> targetClass,
                             String fieldName)
```
    Returns lang.reflect.Field for given target class and fieldName. It searches for first mach field in class hierarchy.
    
    Parameters:
    
    targetClass - class from which will start searching.
    
    fieldName - name of object property.
    
    Returns:
    
    instance of Field.
  - getTypeOfArrayField
```
public static Class<?> getTypeOfArrayField(Field field)
```
    Return type of field which is expected to be array field.
    
    Parameters:
    
    field - instance of field.
    
    Returns:
    
    type which stores a array field.
  - getMethod
```
public static Method getMethod(Object targetObject,
                               String methodName,
                               Class<?>... argClasses)
```
    It returns method for given target object.
    
    Parameters:
    
    targetObject - instance for which will start looking for method in object hierarchy.
    
    methodName - method name.
    
    argClasses - types of arguments.
    
    Returns:
    
    instance of method.
  - getMethod
```
public static Method getMethod(Class<?> targetClass,
                               String methodName,
                               Class<?>... argClasses)
```
    It returns method for given target object.
    
    Parameters:
    
    targetClass - target class for which will start looking for method in object hierarchy.
    
    methodName - method name.
    
    argClasses - types of arguments.
    
    Returns:
    
    instance of method.
  - getAllChildClassesForClass
```
public static <T> Set<Class<? extends T>> getAllChildClassesForClass(Class<T> superType,
                                                                     String packageDefinition,
                                                                     boolean withAbstractClasses)
```
    It will search for all classes which inherit from provided super type. It will not add to result class for superType argument. It can add abstract classes to result or not.
    
    Type Parameters:
    
    T - generic type of super type of class.
    
    Parameters:
    
    superType - super type which will not added to result set.
    
    packageDefinition - package from which will search for child classes.
    
    withAbstractClasses - by this flag depends that result set will have abstract classes in result set.
    
    Returns:
    
    result set with child classes for super class, without super class instance.
  - isSimpleType
```
public static boolean isSimpleType(Field field)
```
    It checks that given field is simple type. If is primitive or class of field inherits from some classes from SIMPLE_CLASSES
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isSimpleType
```
public static boolean isSimpleType(Class<?> someClass)
```
    It checks that given class is simple type. If is primitive or class inherits from some classes from SIMPLE_CLASSES
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - isNumberType
```
public static boolean isNumberType(Field field)
```
    It checks that given field is number type. If is primitive or class of field inherits from some classes from SIMPLE_NUMBERS
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isNumberType
```
public static boolean isNumberType(Class<?> someClass)
```
    It checks that given class is number type. If is primitive or class inherit from some class from SIMPLE_NUMBERS
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - isTextType
```
public static boolean isTextType(Field field)
```
    It checks that given field is simple string type.
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isTextType
```
public static boolean isTextType(Class<?> someClass)
```
    It checks that given class is simple string type.
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - isEnumType
```
public static boolean isEnumType(Field field)
```
    It checks that given field is simple enum type.
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isEnumType
```
public static boolean isEnumType(Class<?> someClass)
```
    It checks that given class is simple enum type.
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - isMapType
```
public static boolean isMapType(Field field)
```
    It checks that given field is map type.
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isMapType
```
public static boolean isMapType(Class<?> someClass)
```
    It checks that given class is map type.
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - isCollectionType
```
public static boolean isCollectionType(Field field)
```
    It checks that given field is collection type.
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isCollectionType
```
public static boolean isCollectionType(Class<?> someClass)
```
    It checks that given class is collection type.
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - isHavingElementsType
```
public static boolean isHavingElementsType(Field field)
```
    It checks that given field is array or collection type.
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isHavingElementsType
```
public static boolean isHavingElementsType(Class<?> someClass)
```
    It checks that given class is array or collection type.
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - isArrayType
```
public static boolean isArrayType(Field field)
```
    It checks that given field is array type.
    
    Parameters:
    
    field - field which will be verified.
    
    Returns:
    
    boolean value
  - isArrayType
```
public static boolean isArrayType(Class<?> someClass)
```
    It checks that given class is array type.
    
    Parameters:
    
    someClass - class which will be verified.
    
    Returns:
    
    boolean value
  - getParametrizedType
```
public static Class<?> getParametrizedType(Field field,
                                           int index)
```
    It returns a type of generic field by given index.
    
    Parameters:
    
    field - field for which will be returned class for generic type.
    
    index - of wanted generic type
    
    Returns:
    
    type of generic type from field from specified index.
  - getParametrizedType
```
public static Class<?> getParametrizedType(Object targetObject,
                                           int index)
```
    It returns a type of generic object by given index.
    
    Parameters:
    
    targetObject - instance object for which will be returned class for generic type.
    
    index - of wanted generic type
    
    Returns:
    
    type of generic type from field from specified index.
  - getParametrizedType
```
public static Class<?> getParametrizedType(Class<?> originalClass,
                                           int index)
```
    It returns a type of generic class by given index.
    
    Parameters:
    
    originalClass - class for which will be returned class for generic type.
    
    index - of wanted generic type
    
    Returns:
    
    type of generic type from field from specified index.
  - getClassForName
```
public static Class<?> getClassForName(String className)
```
    It returns raw class, under the hood is used apache lang3. When cannot find class name then throws ReflectionOperationException
    
    Parameters:
    
    className - name of class
    
    Returns:
    
    instance Of class
  - getParametrizedRawTypes
```
public static List<Type> getParametrizedRawTypes(Class<?> someClass)
```
    It returns some parametrized types for given class. But it not search in whole hierarchy of provided class. It returns only for certain class.
    
    Parameters:
    
    someClass - instance of certain class
    
    Returns:
    
    list of parametrized types.
  - getTypeMetadataFromClass
```
public static TypeMetadata getTypeMetadataFromClass(Class<?> someClass)
```
    It builds metadata for provided class. It resolves generic types for this class and for them super classes. But it cannot be used for class which doesn't have parametrized real types.
    
    Parameters:
    
    someClass - instance of class which has provided all generic types as real class
    
    Returns:
    
    instance of TypeMetadata
  - getTypeMetadataFromField
```
public static TypeMetadata getTypeMetadataFromField(Field field)
```
    It build metadata from provided field but field needs to have all generic types as real classes.
    
    Parameters:
    
    field - field with all generic types as real classes.
    
    Returns:
    
    instance of TypeMetadata built upon field
  - getTypeMetadataFromField
```
public static TypeMetadata getTypeMetadataFromField(Field field,
                                                    int index)
```
    It returns generic type from certain field by index.
    
    Parameters:
    
    field - for which should be resolved instance of type metadata under provided index.
    
    index - index of generic type in field.
    
    Returns:
    
    instance of TypeMetadata from generic type under provided index in provided field.
  - getTypeMetadataFromType
```
public static TypeMetadata getTypeMetadataFromType(Type type)
```
    It build metadata from simple type. Type should contains already info about real classes.
    
    Parameters:
    
    type - type with real class name for generic types.
    
    Returns:
    
    metadata built on provided type.
  - getTypeMetadataOfArray
```
public static TypeMetadata getTypeMetadataOfArray(Field field)
```
    It returns metadata of type stored in field which is array type. It returns metadata for type of array.
    
    Parameters:
    
    field - array field
    
    Returns:
    
    metadata for stored type in provided array field.

Class MetadataReflectionUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getField

getField

getTypeOfArrayField

getMethod

getMethod

getAllChildClassesForClass

isSimpleType

isSimpleType

isNumberType

isNumberType

isTextType

isTextType

isEnumType

isEnumType

isMapType

isMapType

isCollectionType

isCollectionType

isHavingElementsType

isHavingElementsType

isArrayType

isArrayType

getParametrizedType

getParametrizedType

getParametrizedType

getClassForName

getParametrizedRawTypes

getTypeMetadataFromClass

getTypeMetadataFromField

getTypeMetadataFromField

getTypeMetadataFromType

getTypeMetadataOfArray