org.springframework.cglib.beans.BeanGenerator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-core Show documentation
Spring Core
There is a newer version: 6.1.8
/*
 * Copyright 2003 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.cglib.beans;

import java.beans.PropertyDescriptor;
import java.security.ProtectionDomain;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import org.springframework.asm.ClassVisitor;
import org.springframework.asm.Type;
import org.springframework.cglib.core.AbstractClassGenerator;
import org.springframework.cglib.core.ClassEmitter;
import org.springframework.cglib.core.Constants;
import org.springframework.cglib.core.EmitUtils;
import org.springframework.cglib.core.KeyFactory;
import org.springframework.cglib.core.ReflectUtils;

/**
 * @author Juozas Baliuka, Chris Nokleberg
 */
@SuppressWarnings({"rawtypes", "unchecked"})
public class BeanGenerator extends AbstractClassGenerator
{
	private static final Source SOURCE = new Source(BeanGenerator.class.getName());
	private static final BeanGeneratorKey KEY_FACTORY =
	  (BeanGeneratorKey)KeyFactory.create(BeanGeneratorKey.class);

	interface BeanGeneratorKey {
		public Object newInstance(String superclass, Map props);
	}

	private Class superclass;
	private Map props = new HashMap();
	private boolean classOnly;

	public BeanGenerator() {
		super(SOURCE);
	}

	/**
	 * Set the class which the generated class will extend. The class
	 * must not be declared as final, and must have a non-private
	 * no-argument constructor.
	 * @param superclass class to extend, or null to extend Object
	 */
	public void setSuperclass(Class superclass) {
		if (superclass != null && superclass.equals(Object.class)) {
			superclass = null;
		}
		this.superclass = superclass;
		// SPRING PATCH BEGIN
		setContextClass(superclass);
		// SPRING PATCH END
	}

	public void addProperty(String name, Class type) {
		if (props.containsKey(name)) {
			throw new IllegalArgumentException("Duplicate property name \"" + name + "\"");
		}
		props.put(name, Type.getType(type));
	}

	@Override
	protected ClassLoader getDefaultClassLoader() {
		if (superclass != null) {
			return superclass.getClassLoader();
		} else {
			return null;
		}
	}

	@Override
	protected ProtectionDomain getProtectionDomain() {
		return ReflectUtils.getProtectionDomain(superclass);
	}

	public Object create() {
		classOnly = false;
		return createHelper();
	}

	public Object createClass() {
		classOnly = true;
		return createHelper();
	}

	private Object createHelper() {
		if (superclass != null) {
			setNamePrefix(superclass.getName());
		}
		String superName = (superclass != null) ? superclass.getName() : "java.lang.Object";
		Object key = KEY_FACTORY.newInstance(superName, props);
		return super.create(key);
	}

	@Override
	public void generateClass(ClassVisitor v) throws Exception {
		int size = props.size();
		String[] names = (String[])props.keySet().toArray(new String[size]);
		Type[] types = new Type[size];
		for (int i = 0; i < size; i++) {
			types[i] = (Type)props.get(names[i]);
		}
		ClassEmitter ce = new ClassEmitter(v);
		ce.begin_class(Constants.V1_8,
					   Constants.ACC_PUBLIC,
					   getClassName(),
					   superclass != null ? Type.getType(superclass) : Constants.TYPE_OBJECT,
					   null,
					   null);
		EmitUtils.null_constructor(ce);
		EmitUtils.add_properties(ce, names, types);
		ce.end_class();
	}

	@Override
	protected Object firstInstance(Class type) {
		if (classOnly) {
			return type;
		} else {
			return ReflectUtils.newInstance(type);
		}
	}

	@Override
	protected Object nextInstance(Object instance) {
		Class protoclass = (instance instanceof Class clazz) ? clazz : instance.getClass();
		if (classOnly) {
			return protoclass;
		} else {
			return ReflectUtils.newInstance(protoclass);
		}
	}

	public static void addProperties(BeanGenerator gen, Map props) {
		for (Iterator it = props.keySet().iterator(); it.hasNext();) {
			String name = (String)it.next();
			gen.addProperty(name, (Class)props.get(name));
		}
	}

	public static void addProperties(BeanGenerator gen, Class type) {
		addProperties(gen, ReflectUtils.getBeanProperties(type));
	}

	public static void addProperties(BeanGenerator gen, PropertyDescriptor[] descriptors) {
		for (PropertyDescriptor descriptor : descriptors) {
			gen.addProperty(descriptor.getName(), descriptor.getPropertyType());
		}
	}
}