jodd.introspector

Class ClassDescriptor

java.lang.Object

jodd.introspector.ClassDescriptor

public class ClassDescriptor
extends java.lang.Object

A descriptor class for all methods/fields/constructors of a class. Static methods/fields are ignored. Hash table is pre-built to speed up query.

Descriptors are 'lazy': various internal caches are created only on request.

Throughout this class, public members are defined as members defined with "public" keyword and declared in a public type. Public members declared by a non-public class is considered non-public because access to it from outside is prohibited by the java access control anyway.

Public members defined in public classes are always preferred even when we allow private/protected members and types to be visible. So if a non-public subtype and a public super type both have a field with the same name, the field in the public super type is always used.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	accessibleOnly
protected jodd.introspector.Ctors	allCtors
protected jodd.introspector.Fields	allFields
protected jodd.introspector.Methods	allMethods
protected jodd.introspector.Properties	allProperties
protected jodd.introspector.Ctors	publicCtors
protected jodd.introspector.Fields	publicFields
protected jodd.introspector.Methods	publicMethods
protected jodd.introspector.Properties	publicProperties
protected java.lang.Class	type
protected int	usageCount

Constructor Summary

Constructors

Constructor and Description
ClassDescriptor(java.lang.Class type, boolean accessibleOnly)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAllBeanGetterNames(boolean declared) Returns all bean getters names.
java.lang.reflect.Method[]	getAllBeanGetters(boolean declared) Returns all bean getters.
java.lang.String[]	getAllBeanSetterNames(boolean declared) Returns an array of all bean setters names.
java.lang.reflect.Method[]	getAllBeanSetters(boolean declared) Returns an array of all bean setters.
java.lang.reflect.Constructor[]	getAllCtors(boolean declared) Returns an array of all ctors.
java.lang.reflect.Field[]	getAllFields(boolean declared) Returns an array of all fields.
java.lang.reflect.Method[]	getAllMethods(boolean declared) Returns an array of all methods.
java.lang.reflect.Method[]	getAllMethods(java.lang.String name, boolean declared) Returns an array of all methods with the same name.
java.lang.reflect.Method	getBeanGetter(java.lang.String name, boolean declared) Returns bean getter identified by name.
MethodDescriptor	getBeanGetterMethodDescriptor(java.lang.String name, boolean declared) Returns MethodDescriptor for bean setter identified by name.
java.lang.reflect.Method	getBeanSetter(java.lang.String name, boolean declared) Returns bean setter identified by name.
MethodDescriptor	getBeanSetterMethodDescriptor(java.lang.String name, boolean declared) Returns bean setter MethodDescriptor identified by name.
java.lang.reflect.Constructor	getCtor(java.lang.Class[] args, boolean declared) Returns the constructor identified by arguments or null if not found.
int	getCtorsCount(boolean declared) Returns the total number of constructors.
java.lang.reflect.Constructor	getDefaultCtor() Returns the public default ctor or null if not found.
java.lang.reflect.Constructor	getDefaultCtor(boolean declared) Returns the default ctor or null if not found.
java.lang.reflect.Field	getField(java.lang.String name, boolean declared) Returns the field identified by name or null if not found.
FieldDescriptor	getFieldDescriptor(java.lang.String name, boolean declared) Returns field descriptor.
int	getFieldsCount(boolean declared) Returns the total number of fields.
java.lang.reflect.Method	getMethod(java.lang.String name, boolean declared) Returns the method identified by name or null if not found.
java.lang.reflect.Method	getMethod(java.lang.String name, java.lang.Class[] params, boolean declared) Returns the method identified by name and parameters.
MethodDescriptor	getMethodDescriptor(java.lang.String name, java.lang.Class[] params, boolean declared) Returns method descriptor identified by name and parameters.
int	getMethodsCount(boolean declared) Returns methods count.
java.lang.Class	getType() Get the class object that this descriptor describes.
int	getUsageCount() Returns number of class description usages.
protected void	increaseUsageCount() Increases descriptor usage.
protected void	inspectCtors() Inspect class ctors and create ctors cache.
protected void	inspectFields() Inspect class fields and create fields cache.
protected void	inspectMethods() Inspect methods and create methods cache.
protected void	inspectProperties() Inspect methods and create properties cache.
boolean	isArray() Returns true if class is an array.
boolean	isCollection() Returns true if type is a collection.
boolean	isList() Returns true if class is a List.
boolean	isMap() Returns true if class is a Map.
boolean	isSet() Returns true if type is a Set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

protected final java.lang.Class type

accessibleOnly

protected final boolean accessibleOnly

usageCount

protected int usageCount

publicFields

protected jodd.introspector.Fields publicFields

allFields

protected jodd.introspector.Fields allFields

publicMethods

protected jodd.introspector.Methods publicMethods

allMethods

protected jodd.introspector.Methods allMethods

publicProperties

protected jodd.introspector.Properties publicProperties

allProperties

protected jodd.introspector.Properties allProperties

publicCtors

protected jodd.introspector.Ctors publicCtors

allCtors

protected jodd.introspector.Ctors allCtors

Constructor Detail

ClassDescriptor

public ClassDescriptor(java.lang.Class type,
               boolean accessibleOnly)

Method Detail

getType

public java.lang.Class getType()

Get the class object that this descriptor describes.

increaseUsageCount

protected void increaseUsageCount()

Increases descriptor usage.

getUsageCount

public int getUsageCount()

Returns number of class description usages.

isArray

public boolean isArray()

Returns true if class is an array.

isMap

public boolean isMap()

Returns true if class is a Map.

isList

public boolean isList()

Returns true if class is a List.

isSet

public boolean isSet()

Returns true if type is a Set.

isCollection

public boolean isCollection()

Returns true if type is a collection.

inspectFields

protected void inspectFields()

Inspect class fields and create fields cache.

getField

public java.lang.reflect.Field getField(java.lang.String name,
                               boolean declared)

Returns the field identified by name or null if not found.

Parameters:

name - field name

declared - whether to look at non-public ones.

getFieldsCount

public int getFieldsCount(boolean declared)

Returns the total number of fields.

getAllFields

public java.lang.reflect.Field[] getAllFields(boolean declared)

Returns an array of all fields.

getFieldDescriptor

public FieldDescriptor getFieldDescriptor(java.lang.String name,
                                 boolean declared)

Returns field descriptor.

inspectMethods

protected void inspectMethods()

Inspect methods and create methods cache.

getMethodsCount

public int getMethodsCount(boolean declared)

Returns methods count.

getMethod

public java.lang.reflect.Method getMethod(java.lang.String name,
                                 boolean declared)

Returns the method identified by name or null if not found.

Parameters:

name - method name

declared - whether to look at non-public ones.

getMethod

public java.lang.reflect.Method getMethod(java.lang.String name,
                                 java.lang.Class[] params,
                                 boolean declared)

Returns the method identified by name and parameters.

getMethodDescriptor

public MethodDescriptor getMethodDescriptor(java.lang.String name,
                                   java.lang.Class[] params,
                                   boolean declared)

Returns method descriptor identified by name and parameters.

getAllMethods

public java.lang.reflect.Method[] getAllMethods(java.lang.String name,
                                       boolean declared)

Returns an array of all methods with the same name.

getAllMethods

public java.lang.reflect.Method[] getAllMethods(boolean declared)

Returns an array of all methods.

inspectProperties

protected void inspectProperties()

Inspect methods and create properties cache.

getBeanSetter

public java.lang.reflect.Method getBeanSetter(java.lang.String name,
                                     boolean declared)

Returns bean setter identified by name.

getBeanSetterMethodDescriptor

public MethodDescriptor getBeanSetterMethodDescriptor(java.lang.String name,
                                             boolean declared)

Returns bean setter MethodDescriptor identified by name.

getAllBeanSetters

public java.lang.reflect.Method[] getAllBeanSetters(boolean declared)

Returns an array of all bean setters.

getAllBeanSetterNames

public java.lang.String[] getAllBeanSetterNames(boolean declared)

Returns an array of all bean setters names.

getBeanGetter

public java.lang.reflect.Method getBeanGetter(java.lang.String name,
                                     boolean declared)

Returns bean getter identified by name.

getBeanGetterMethodDescriptor

public MethodDescriptor getBeanGetterMethodDescriptor(java.lang.String name,
                                             boolean declared)

Returns MethodDescriptor for bean setter identified by name.

getAllBeanGetters

public java.lang.reflect.Method[] getAllBeanGetters(boolean declared)

Returns all bean getters.

getAllBeanGetterNames

public java.lang.String[] getAllBeanGetterNames(boolean declared)

Returns all bean getters names.

inspectCtors

protected void inspectCtors()

Inspect class ctors and create ctors cache.

getDefaultCtor

public java.lang.reflect.Constructor getDefaultCtor(boolean declared)

Returns the default ctor or null if not found.

getCtor

public java.lang.reflect.Constructor getCtor(java.lang.Class[] args,
                                    boolean declared)

Returns the constructor identified by arguments or null if not found.

Parameters:

args - ctor arguments

declared - whether to look at non-public ones.

getDefaultCtor

public java.lang.reflect.Constructor getDefaultCtor()

Returns the public default ctor or null if not found.

getCtorsCount

public int getCtorsCount(boolean declared)

Returns the total number of constructors.

getAllCtors

public java.lang.reflect.Constructor[] getAllCtors(boolean declared)

Returns an array of all ctors.