/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2009-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.buildtime.spi;

import java.io.File;
import java.util.Set;

Basic contract for performing instrumentation.
Author:
Steve Ebersole/**
 * Basic contract for performing instrumentation.
 *
 * @author Steve Ebersole
 */
public interface Instrumenter {
	
Perform the instrumentation.
Params:
files – The file on which to perform instrumentation/**
	 * Perform the instrumentation.
	 *
	 * @param files The file on which to perform instrumentation
	 */
	public void execute(Set<File> files);

	
Instrumentation options.
/**
	 * Instrumentation options.
	 */
	public static interface Options {
		
Should we enhance references to class fields outside the class itself?
Returns:
true/false/**
		 * Should we enhance references to class fields outside the class itself?
		 *
		 * @return {@literal true}/{@literal false}
		 */
		public boolean performExtendedInstrumentation();
	}
}