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

import org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor;

Defines the contract for Hibernate to be able to scan for classes, packages and resources inside a
persistence unit.
Author:
Emmanuel Bernard, Steve Ebersole/**
 * Defines the contract for Hibernate to be able to scan for classes, packages and resources inside a
 * persistence unit.
 *
 * @author Emmanuel Bernard
 * @author Steve Ebersole
 */
public interface Scanner {
	
Perform the scanning against the described persistence unit using the defined options, and return the scan
results.
Params:
persistenceUnit – THe description of the persistence unit.
options – The scan options
Returns:
The scan results./**
	 * Perform the scanning against the described persistence unit using the defined options, and return the scan
	 * results.
	 *
	 * @param persistenceUnit THe description of the persistence unit.
	 * @param options The scan options
	 *
	 * @return The scan results.
	 */
	public ScanResult scan(PersistenceUnitDescriptor persistenceUnit, ScanOptions options);
}