jodd.introspector.ClassDescriptor Maven / Gradle / Ivy
// Copyright (c) 2003-present, Jodd Team (http://jodd.org)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
package jodd.introspector;
import jodd.util.ClassUtil;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Supplier;
/**
* A descriptor class for all methods/fields/properties/constructors of a class.
* Static methods/fields are ignored.
*
* Descriptors are 'lazy': various internal caches are created on first 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.
*/
public class ClassDescriptor {
protected final Class type;
protected final boolean scanAccessible;
protected final boolean extendedProperties;
protected final boolean includeFieldsAsProperties;
protected final String[] propertyFieldPrefix;
protected final Class[] interfaces;
protected final Class[] superclasses;
public ClassDescriptor(final Class type, final boolean scanAccessible, final boolean extendedProperties, final boolean includeFieldsAsProperties, final String[] propertyFieldPrefix) {
this.type = type;
this.scanAccessible = scanAccessible;
this.extendedProperties = extendedProperties;
this.includeFieldsAsProperties = includeFieldsAsProperties;
this.propertyFieldPrefix = propertyFieldPrefix;
isArray = type.isArray();
isMap = ClassUtil.isTypeOf(type, Map.class);
isList = ClassUtil.isTypeOf(type, List.class);
isSet = ClassUtil.isTypeOf(type, Set.class);
isCollection = ClassUtil.isTypeOf(type, Collection.class);
isSupplier = ClassUtil.isTypeOf(type, Supplier.class);
interfaces = ClassUtil.resolveAllInterfaces(type);
superclasses = ClassUtil.resolveAllSuperclasses(type);
isSystemClass = type.getName().startsWith("java.") &&
!type.getName().startsWith("java.awt.geom.");
}
/**
* Get the class object that this descriptor describes.
*/
public Class getType() {
return type;
}
/**
* Returns true if this class descriptor
* works with accessible fields/methods/constructors or with
* all supported.
*/
public boolean isScanAccessible() {
return scanAccessible;
}
/**
* Returns true if properties in this class descriptor
* are extended and include field description.
*/
public boolean isExtendedProperties() {
return extendedProperties;
}
/**
* Include fields as properties.
*/
public boolean isIncludeFieldsAsProperties() {
return includeFieldsAsProperties;
}
/**
* Returns property field prefixes. May be null
* if prefixes are not set. If you need to access both prefixed
* and non-prefixed fields, use empty string as one of the prefixes.
*/
public String[] getPropertyFieldPrefix() {
return propertyFieldPrefix;
}
// ---------------------------------------------------------------- special
private final boolean isArray;
/**
* Returns true if class is an array.
*/
public boolean isArray() {
return isArray;
}
private final boolean isMap;
/**
* Returns true if class is a Map.
*/
public boolean isMap() {
return isMap;
}
private final boolean isList;
/**
* Returns true if class is a List.
*/
public boolean isList() {
return isList;
}
private final boolean isSet;
/**
* Returns true if type is a Set.
*/
public boolean isSet() {
return isSet;
}
private final boolean isCollection;
/**
* Returns true if type is a collection.
*/
public boolean isCollection() {
return isCollection;
}
private final boolean isSupplier;
/**
* Returns true if type is a supplier.
*/
public boolean isSupplier() {
return isSupplier;
}
private boolean isSystemClass;
/**
* Returns true is class is a system class and should not
* expose fields or declared methods.
*/
public boolean isSystemClass() {
return isSystemClass;
}
// ---------------------------------------------------------------- fields
private Fields fields;
/**
* Returns {@link Fields fields collection}.
* Creates new fields collection on first usage.
*/
protected Fields getFields() {
if (fields == null) {
fields = new Fields(this);
}
return fields;
}
/**
* Returns field descriptor.
*/
public FieldDescriptor getFieldDescriptor(final String name, final boolean declared) {
final FieldDescriptor fieldDescriptor = getFields().getFieldDescriptor(name);
if (fieldDescriptor != null) {
if (!fieldDescriptor.matchDeclared(declared)) {
return null;
}
}
return fieldDescriptor;
}
/**
* Returns all field descriptors, including declared ones.
*/
public FieldDescriptor[] getAllFieldDescriptors() {
return getFields().getAllFieldDescriptors();
}
// ---------------------------------------------------------------- methods
private Methods methods;
/**
* Returns methods collection.
* Creates new collection on first access.
*/
protected Methods getMethods() {
if (methods == null) {
methods = new Methods(this);
}
return methods;
}
/**
* Returns {@link MethodDescriptor method descriptor} identified by name and parameters.
*/
public MethodDescriptor getMethodDescriptor(final String name, final boolean declared) {
final MethodDescriptor methodDescriptor = getMethods().getMethodDescriptor(name);
if ((methodDescriptor != null) && methodDescriptor.matchDeclared(declared)) {
return methodDescriptor;
}
return methodDescriptor;
}
/**
* Returns {@link MethodDescriptor method descriptor} identified by name and parameters.
*/
public MethodDescriptor getMethodDescriptor(final String name, final Class[] params, final boolean declared) {
final MethodDescriptor methodDescriptor = getMethods().getMethodDescriptor(name, params);
if ((methodDescriptor != null) && methodDescriptor.matchDeclared(declared)) {
return methodDescriptor;
}
return null;
}
/**
* Returns an array of all methods with the same name.
*/
public MethodDescriptor[] getAllMethodDescriptors(final String name) {
return getMethods().getAllMethodDescriptors(name);
}
/**
* Returns an array of all methods.
*/
public MethodDescriptor[] getAllMethodDescriptors() {
return getMethods().getAllMethodDescriptors();
}
// ---------------------------------------------------------------- properties
private Properties properties;
/**
* Returns properties collection.
* Creates new collection on first access.
*/
protected Properties getProperties() {
if (properties == null) {
properties = new Properties(this);
}
return properties;
}
/**
* Returns property descriptor. Declared flag is matched on both read and write
* methods.
*/
public PropertyDescriptor getPropertyDescriptor(final String name, final boolean declared) {
PropertyDescriptor propertyDescriptor = getProperties().getPropertyDescriptor(name);
if ((propertyDescriptor != null) && propertyDescriptor.matchDeclared(declared)) {
return propertyDescriptor;
}
return null;
}
/**
* Returns all properties descriptors.
*/
public PropertyDescriptor[] getAllPropertyDescriptors() {
return getProperties().getAllPropertyDescriptors();
}
// ---------------------------------------------------------------- ctors
private Ctors ctors;
/**
* Returns constructors collection.
* Creates new collection of first access.
*/
protected Ctors getCtors() {
if (ctors == null) {
ctors = new Ctors(this);
}
return ctors;
}
/**
* Returns the default ctor or null if not found.
*/
public CtorDescriptor getDefaultCtorDescriptor(final boolean declared) {
CtorDescriptor defaultCtor = getCtors().getDefaultCtor();
if ((defaultCtor != null) && defaultCtor.matchDeclared(declared)) {
return defaultCtor;
}
return null;
}
/**
* Returns the constructor identified by arguments or null if not found.
*/
public CtorDescriptor getCtorDescriptor(final Class[] args, final boolean declared) {
CtorDescriptor ctorDescriptor = getCtors().getCtorDescriptor(args);
if ((ctorDescriptor != null) && ctorDescriptor.matchDeclared(declared)) {
return ctorDescriptor;
}
return null;
}
/**
* Returns an array of all {@link CtorDescriptor constructor descriptors}.
*/
public CtorDescriptor[] getAllCtorDescriptors() {
return getCtors().getAllCtorDescriptors();
}
// ---------------------------------------------------------------- interfaces
/**
* Returns all interfaces of this class.
*/
public Class[] getAllInterfaces() {
return interfaces;
}
/**
* Returns all superclasses of this class.
* Object.class is not included in the
* returned list.
*/
public Class[] getAllSuperclasses() {
return superclasses;
}
}