ClassUtil (AssertJ Assertions Generator 2.2.1 API)

java.lang.Object
- org.assertj.assertions.generator.util.ClassUtil

```
public class ClassUtil
extends Object
```
Some utilities methods related to classes and packages.

Field Summary

Fields
Modifier and Type Field and Description

static String GET_PREFIX

static Package JAVA_LANG_PACKAGE

static Map<String,String> PREDICATE_PREFIXES

Fields
Modifier and Type	Field and Description
`static String`	`GET_PREFIX`
`static Package`	`JAVA_LANG_PACKAGE`
`static Map<String,String>`	`PREDICATE_PREFIXES`

Constructor Summary

Constructors
Constructor and Description

ClassUtil()

Constructors
Constructor and Description
`ClassUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Set<com.google.common.reflect.TypeToken<?>>`	`collectClasses(ClassLoader classLoader, boolean includePrivateClasses, String... classOrPackageNames)` Collects all the classes from given classes names or classes belonging to given a package name (recursively), with control on private classes including.
`static Set<com.google.common.reflect.TypeToken<?>>`	`collectClasses(ClassLoader classLoader, String... classOrPackageNames)` Collects all the public classes from given classes names or classes belonging to given a package name (recursively).
`static Set<com.google.common.reflect.TypeToken<?>>`	`collectClasses(String... classOrPackageNames)` Call `collectClasses(ClassLoader, String...)` with `Thread.currentThread().getContextClassLoader()`
`static List<Field>`	`declaredFieldsOf(com.google.common.reflect.TypeToken<?> type)`
`static Set<Method>`	`declaredGetterMethodsOf(com.google.common.reflect.TypeToken<?> type, Set<Class<?>> includeAnnotations)`
`static List<Field>`	`getAllFieldsInHierarchy(com.google.common.reflect.TypeToken<?> clazz)` Retrieves all fields (whatever access levels) in the hierarchy of a class up to Object.class excluded.
`static String`	`getAssertType(com.google.common.reflect.TypeToken<?> type, String packageName)` Gets the name of the class that will be the "assert".
`static Class<?>`	`getClass(Type type)` Get the underlying class for a valueType, or null if the valueType is a variable valueType.
`static Set<Class<?>>`	`getClassesRelatedTo(Type type)`
`static String`	`getNegativePredicateFor(String name)`
`static String`	`getPredicatePrefix(String name)`
`static String`	`getSimpleNameWithOuterClass(Class<?> clazz)` Gets the simple name of the class but, unlike `Class.getSimpleName()`, it includes the name of the outer class when `clazz` is an inner class.
`static Set<Method>`	`getterMethodsOf(com.google.common.reflect.TypeToken<?> type, Set<Class<?>> includeAnnotations)`
`static String`	`getTypeDeclaration(com.google.common.reflect.TypeToken<?> type)` Generates a "type declaration" that could be used in Java code based on the `type`.
`static String`	`getTypeNameWithoutDots(String typeName)` Gets a type name without any dots in it if they are present -- this is for nested classes
`static boolean`	`inheritsCollectionOrIsIterable(Class<?> returnType)`
`static boolean`	`isBoolean(com.google.common.reflect.TypeToken<?> type)` Checks if a type is a boolean type
`static boolean`	`isInnerPackageOf(Package child, Package parent)` Checks if the package, `child` is under the package `parent`.
`static boolean`	`isJavaLangType(Type type)` Checks if the type passed is a member of `java.lang` or is a "built-in" type (e.g.
`static boolean`	`isJavaLangType(com.google.common.reflect.TypeToken<?> type)` Checks if the type passed is a member of `java.lang` or is a "built-in" type (e.g.
`static boolean`	`isPredicate(Method method)`
`static boolean`	`isStandardGetter(Method method)`
`static boolean`	`isValidGetterName(String methodName)`
`static boolean`	`isValidPredicateName(String name)`
`static List<Field>`	`nonStaticFieldsOf(com.google.common.reflect.TypeToken<?> clazz)`
`static String`	`packageNameRegex(String packageName)`
`static String`	`packageOf(String fullyQualifiedType)`
`static String`	`propertyNameOf(Field field)` Returns the property name of given field, examples :
`static String`	`propertyNameOf(Method method)` Returns the property name of given getter method, examples :
`static String`	`resolveTypeNameInPackage(Type type, String currentPackage)` Gets the name of a type without the package if `currentPackage` is the same as `type's package`.
`static String`	`resolveTypeNameInPackage(com.google.common.reflect.TypeToken<?> type, String currentPackage)` Gets the name of a type without the package if `currentPackage` is the same as `type's package`.
`static String`	`safePackageName(com.google.common.reflect.TypeToken<?> typeToken)`
`static Visibility`	`visibilityOf(Field field)`

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

- Field Detail
  - GET_PREFIX
```
public static final String GET_PREFIX
```
    See Also:
    
    Constant Field Values
  - JAVA_LANG_PACKAGE
```
public static final Package JAVA_LANG_PACKAGE
```
  - PREDICATE_PREFIXES
```
public static final Map<String,String> PREDICATE_PREFIXES
```
- Constructor Detail
  - ClassUtil
```
public ClassUtil()
```
- Method Detail
  - collectClasses
```
public static Set<com.google.common.reflect.TypeToken<?>> collectClasses(String... classOrPackageNames)
```
    Call collectClasses(ClassLoader, String...) with Thread.currentThread().getContextClassLoader()
    
    Parameters:
    
    classOrPackageNames - classes or packages to collect.
    
    Returns:
    
    the set of TypeTokens found
  - collectClasses
```
public static Set<com.google.common.reflect.TypeToken<?>> collectClasses(ClassLoader classLoader,
                                                                         String... classOrPackageNames)
```
    Collects all the public classes from given classes names or classes belonging to given a package name (recursively). Note that anonymous and local classes are excluded from the returned classes.
    
    Parameters:
    
    classLoader - ClassLoader used to load classes defines in classOrPackageNames
    
    classOrPackageNames - classes names or packages names we want to collect classes from (recursively for packages)
    
    Returns:
    
    the set of Classes found
    
    Throws:
    
    RuntimeException - if any error occurs
  - collectClasses
```
public static Set<com.google.common.reflect.TypeToken<?>> collectClasses(ClassLoader classLoader,
                                                                         boolean includePrivateClasses,
                                                                         String... classOrPackageNames)
```
    Collects all the classes from given classes names or classes belonging to given a package name (recursively), with control on private classes including. Note that anonymous and local classes are excluded from the returned classes.
    
    Parameters:
    
    classLoader - ClassLoader used to load classes defines in classOrPackageNames
    
    includePrivateClasses - ClassLoader used to include private classes when true
    
    classOrPackageNames - classes names or packages names we want to collect classes from (recursively for packages)
    
    Returns:
    
    the set of Classes found
    
    Throws:
    
    RuntimeException - if any error occurs
  - propertyNameOf
```
public static String propertyNameOf(Method method)
```
    Returns the property name of given getter method, examples :
```
 getName() -> name
 
```
```
 isMostValuablePlayer() -> mostValuablePlayer
 
```
    Parameters:
    
    method - getter method to deduce property from.
    
    Returns:
    
    the property name of given getter method
  - propertyNameOf
```
public static String propertyNameOf(Field field)
```
    Returns the property name of given field, examples :
```
 name -> name
 isMostValuablePlayer -> mostValuablePlayer
 
```
    Parameters:
    
    field - field to deduce property from.
    
    Returns:
    
    the property name of given field
  - inheritsCollectionOrIsIterable
```
public static boolean inheritsCollectionOrIsIterable(Class<?> returnType)
```
  - isStandardGetter
```
public static boolean isStandardGetter(Method method)
```
  - isPredicate
```
public static boolean isPredicate(Method method)
```
  - isValidGetterName
```
public static boolean isValidGetterName(String methodName)
```
  - getPredicatePrefix
```
public static String getPredicatePrefix(String name)
```
  - isValidPredicateName
```
public static boolean isValidPredicateName(String name)
```
  - getNegativePredicateFor
```
public static String getNegativePredicateFor(String name)
```
  - declaredGetterMethodsOf
```
public static Set<Method> declaredGetterMethodsOf(com.google.common.reflect.TypeToken<?> type,
                                                  Set<Class<?>> includeAnnotations)
```
  - getterMethodsOf
```
public static Set<Method> getterMethodsOf(com.google.common.reflect.TypeToken<?> type,
                                          Set<Class<?>> includeAnnotations)
```
  - nonStaticFieldsOf
```
public static List<Field> nonStaticFieldsOf(com.google.common.reflect.TypeToken<?> clazz)
```
  - declaredFieldsOf
```
public static List<Field> declaredFieldsOf(com.google.common.reflect.TypeToken<?> type)
```
  - getAllFieldsInHierarchy
```
public static List<Field> getAllFieldsInHierarchy(com.google.common.reflect.TypeToken<?> clazz)
```
    Retrieves all fields (whatever access levels) in the hierarchy of a class up to Object.class excluded.
    
    Parameters:
    
    clazz - the class whose fields should be retrieved
    
    Returns:
    
    all fields (whatever access levels) in the hierarchy of a class up to Object.class excluded.
  - getClassesRelatedTo
```
public static Set<Class<?>> getClassesRelatedTo(Type type)
```
  - getSimpleNameWithOuterClass
```
public static String getSimpleNameWithOuterClass(Class<?> clazz)
```
    Gets the simple name of the class but, unlike Class.getSimpleName(), it includes the name of the outer class when clazz is an inner class.
    
    Parameters:
    
    clazz - the class
    
    Returns:
    
    the simple name of the class prefixed by the outer class if any (separated by dot)
  - getClass
```
public static Class<?> getClass(Type type)
```
    Get the underlying class for a valueType, or null if the valueType is a variable valueType.
    
    Parameters:
    
    type - the valueType
    
    Returns:
    
    the underlying class
  - isInnerPackageOf
```
public static boolean isInnerPackageOf(Package child,
                                       Package parent)
```
    Checks if the package, child is under the package parent.
    
    Parameters:
    
    child - Child package
    
    parent - Parent package
    
    Returns:
    
    True iff the child package is under the parent, false if not or either is null.
  - isJavaLangType
```
public static boolean isJavaLangType(com.google.common.reflect.TypeToken<?> type)
```
    Checks if the type passed is a member of java.lang or is a "built-in" type (e.g. primitive or array).
    
    Parameters:
    
    type - type token
    
    Returns:
    
    true if part of java language
  - isJavaLangType
```
public static boolean isJavaLangType(Type type)
```
    Checks if the type passed is a member of java.lang or is a "built-in" type (e.g. primitive or array).
    
    Parameters:
    
    type - type
    
    Returns:
    
    true if part of java language
    
    See Also:
    
    isJavaLangType(TypeToken)
  - packageOf
```
public static String packageOf(String fullyQualifiedType)
```
  - getTypeDeclaration
```
public static String getTypeDeclaration(com.google.common.reflect.TypeToken<?> type)
```
    Generates a "type declaration" that could be used in Java code based on the type.
    
    Parameters:
    
    type - Type to get declaration for
    
    Returns:
    
    String representation of the type
  - getAssertType
```
public static String getAssertType(com.google.common.reflect.TypeToken<?> type,
                                   String packageName)
```
    Gets the name of the class that will be the "assert".
    
    Parameters:
    
    type - Type being tested
    
    packageName - package this type will reside in
    
    Returns:
    
    Name for "assert" type
  - resolveTypeNameInPackage
```
public static String resolveTypeNameInPackage(com.google.common.reflect.TypeToken<?> type,
                                              String currentPackage)
```
    Gets the name of a type without the package if currentPackage is the same as type's package.
    
    Parameters:
    
    type - Type to import
    
    currentPackage - package context for the string
    
    Returns:
    
    String Name resolved within the package
  - resolveTypeNameInPackage
```
public static String resolveTypeNameInPackage(Type type,
                                              String currentPackage)
```
    Gets the name of a type without the package if currentPackage is the same as type's package.
    
    Parameters:
    
    type - Type to import
    
    currentPackage - package context for the string
    
    Returns:
    
    String Name resolved within the package
  - getTypeNameWithoutDots
```
public static String getTypeNameWithoutDots(String typeName)
```
    Gets a type name without any dots in it if they are present -- this is for nested classes
    
    Parameters:
    
    typeName - String name of the type
    
    Returns:
    
    Type without any '.' characters
  - isBoolean
```
public static boolean isBoolean(com.google.common.reflect.TypeToken<?> type)
```
    Checks if a type is a boolean type
    
    Parameters:
    
    type - Type to check
    
    Returns:
    
    true iff the type is a boolean.
  - safePackageName
```
public static String safePackageName(com.google.common.reflect.TypeToken<?> typeToken)
```
  - packageNameRegex
```
public static String packageNameRegex(String packageName)
```
  - visibilityOf
```
public static Visibility visibilityOf(Field field)
```

Class ClassUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GET_PREFIX

JAVA_LANG_PACKAGE

PREDICATE_PREFIXES

Constructor Detail

ClassUtil

Method Detail

collectClasses

collectClasses

collectClasses

propertyNameOf

propertyNameOf

inheritsCollectionOrIsIterable

isStandardGetter

isPredicate

isValidGetterName

getPredicatePrefix

isValidPredicateName

getNegativePredicateFor

declaredGetterMethodsOf

getterMethodsOf

nonStaticFieldsOf

declaredFieldsOf

getAllFieldsInHierarchy

getClassesRelatedTo

getSimpleNameWithOuterClass

getClass

isInnerPackageOf

isJavaLangType

isJavaLangType

packageOf

getTypeDeclaration

getAssertType

resolveTypeNameInPackage

resolveTypeNameInPackage

getTypeNameWithoutDots

isBoolean

safePackageName

packageNameRegex

visibilityOf