uk.co.it.modular.beans.InstanceInspector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bean-utils Show documentation
Utilities for manipulating and inspecting Java classes implementing the Java Beans standard
There is a newer version: 0.9.10

package uk.co.it.modular.beans;

import static java.lang.System.identityHashCode;
import static org.apache.commons.lang.StringUtils.uncapitalize;
import static uk.co.it.modular.beans.Type.type;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Helper class which inspects the bean and exposes the properties of the bean to support the visitor pattern
 * 
 * @author Stewart Bissett
 */
class InstanceInspector {

	static InstanceInspector beanInspector() {
		return new InstanceInspector(new BeanInspectorConfiguration() {

			{
				setInspectChildren(false);
				setOverflowLimit(0);
				setStopOverflow(true);
			}
		});
	}

	static InstanceInspector graphInspector() {
		return new InstanceInspector(new BeanInspectorConfiguration() {

			{
				setInspectChildren(true);
				setOverflowLimit(0);
				setStopOverflow(true);
			}
		});
	};

	static class BeanInspectorConfiguration {

		private boolean inspectChildren = false;
		private boolean stopOverflow = true;
		private Integer overflowLimit = 0;

		boolean isInspectChildren() {
			return inspectChildren;
		}

		void setInspectChildren(final boolean inspectChildren) {
			this.inspectChildren = inspectChildren;
		}

		boolean isStopOverflow() {
			return stopOverflow;
		}

		void setStopOverflow(final boolean stopOverflow) {
			this.stopOverflow = stopOverflow;
		}

		Integer getOverflowLimit() {
			return overflowLimit;
		}

		void setOverflowLimit(final Integer overflowLimit) {
			this.overflowLimit = overflowLimit;
		}

	}

	private static final Logger LOG = LoggerFactory.getLogger(InstanceInspector.class);

	private final BeanInspectorConfiguration config;
	private final ThreadLocal> inspected = new ThreadLocal>() {

		@Override
		protected Map initialValue() {
			return new HashMap();
		}
	};

	InstanceInspector(final BeanInspectorConfiguration config) {
		this.config = config;
	}

	/**
	 * Inspect the supplied object and fire callbacks on the supplied {@link BeanVisitor} for every property exposed on the object
	 * 
	 * @param instance
	 *            an object instance to inspect for Java Bean properties
	 * @param visitor
	 *            the visitor to raise events when Java Bean properties are found
	 */
	void inspect(final Object instance, final BeanVisitor visitor) {
		inspect(instance, null, visitor);
	}

	/**
	 * Inspect the supplied object and fire callbacks on the supplied {@link BeanVisitor} for every property exposed on the object.
	 * 
	 * The root object will be referred to be the supplied rootPath parameter.
	 * 
	 * 
	 * @param instance
	 *            an object instance to inspect for Java Bean properties
	 * @param rootPath
	 *            a name to be used as the root object name for the path included when the visitor is notified
	 * @param visitor
	 *            the visitor to raise events when Java Bean properties are found
	 */
	void inspect(final Object instance, final String rootPath, final BeanVisitor visitor) {
		try {
			inspectObject(new ArrayList