/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2008-2011, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.bytecode.spi;

import org.hibernate.bytecode.buildtime.spi.ClassFilter;
import org.hibernate.bytecode.buildtime.spi.FieldFilter;

Contract for providers of bytecode services to Hibernate.

Bytecode requirements break down into basically 3 areas

    
proxy generation (both for runtime-lazy-loading and basic proxy generation) getProxyFactoryFactory()
    
bean reflection optimization getReflectionOptimizer
    
field-access instrumentation getTransformer

Author:
Steve Ebersole/**
 * Contract for providers of bytecode services to Hibernate.
 * <p/>
 * Bytecode requirements break down into basically 3 areas<ol>
 *     <li>proxy generation (both for runtime-lazy-loading and basic proxy generation) {@link #getProxyFactoryFactory()}</li>
 *     <li>bean reflection optimization {@link #getReflectionOptimizer}</li>
 *     <li>field-access instrumentation {@link #getTransformer}</li>
 * </ol>
 *
 * @author Steve Ebersole
 */
public interface BytecodeProvider {
	
Retrieve the specific factory for this provider capable of
generating run-time proxies for lazy-loading purposes.
Returns:
The provider specific factory./**
	 * Retrieve the specific factory for this provider capable of
	 * generating run-time proxies for lazy-loading purposes.
	 *
	 * @return The provider specific factory.
	 */
	public ProxyFactoryFactory getProxyFactoryFactory();

	
Retrieve the ReflectionOptimizer delegate for this provider
capable of generating reflection optimization components.
Params:
clazz – The class to be reflected upon.
getterNames – Names of all property getters to be accessed via reflection.
setterNames – Names of all property setters to be accessed via reflection.
types – The types of all properties to be accessed.
Returns:
The reflection optimization delegate./**
	 * Retrieve the ReflectionOptimizer delegate for this provider
	 * capable of generating reflection optimization components.
	 *
	 * @param clazz The class to be reflected upon.
	 * @param getterNames Names of all property getters to be accessed via reflection.
	 * @param setterNames Names of all property setters to be accessed via reflection.
	 * @param types The types of all properties to be accessed.
	 * @return The reflection optimization delegate.
	 */
	public ReflectionOptimizer getReflectionOptimizer(Class clazz, String[] getterNames, String[] setterNames, Class[] types);

	
Generate a ClassTransformer capable of performing bytecode manipulation.
Params:
classFilter – filter used to limit which classes are to be instrumented
via this ClassTransformer.
fieldFilter – filter used to limit which fields are to be instrumented
via this ClassTransformer.
Returns:
The appropriate ClassTransformer./**
	 * Generate a ClassTransformer capable of performing bytecode manipulation.
	 *
	 * @param classFilter filter used to limit which classes are to be instrumented
	 * via this ClassTransformer.
	 * @param fieldFilter filter used to limit which fields are to be instrumented
	 * via this ClassTransformer.
	 * @return The appropriate ClassTransformer.
	 */
	public ClassTransformer getTransformer(ClassFilter classFilter, FieldFilter fieldFilter);

	
Retrieve the interception metadata for the particular entity type.
Params:
entityClass – The entity class.  Note: we pass class here instead of the usual "entity name" because
only real classes can be instrumented.
Returns:
The metadata/**
	 * Retrieve the interception metadata for the particular entity type.
	 *
	 * @param entityClass The entity class.  Note: we pass class here instead of the usual "entity name" because
	 * only real classes can be instrumented.
	 *
	 * @return The metadata
	 */
	public EntityInstrumentationMetadata getEntityInstrumentationMetadata(Class entityClass);
}