EntityMappingExtractor.java

/*
 * Copyright 2012 Jakob Külzer
 * 
 * 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
 *
 *     http://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.om.core.api.mapping.extractor;

import org.om.core.api.exception.MappingException;
import org.om.core.api.mapping.EntityMapping;

/**
 * Extracts {@link EntityMapping}s from a given class.
 * 
 * @author Jakob Külzer
 * 
 */
public interface EntityMappingExtractor {

	/**
	 * Extracts an {@link EntityMapping} from the given class object.
	 * 
	 * @param type
	 * @return
	 * @throws MappingException
	 *             if the given class object is not an entity or for some other
	 *             reason the mapping could not be extracted.
	 */
	EntityMapping extract(Class<?> type) throws MappingException;

}