jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/internal/content/java/IJavaAttributeMappingProvider.java

/*******************************************************************************
 * Copyright (c) 2006, 2007 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.core.internal.content.java;

import org.eclipse.jpt.core.internal.IJpaFactory;
import org.eclipse.jpt.core.internal.jdtutility.Attribute;
import org.eclipse.jpt.core.internal.jdtutility.DeclarationAnnotationAdapter;

/**
 * Map a string key to an attribute mapping and its corresponding
 * Java annotation adapter.
 */
public interface IJavaAttributeMappingProvider {

	/**
	 * A unique String that corresponds to the IJavaAttributeMapping key 
	 */
	String key();

	/**
	 * Create an IJavaAttributeMapping for the given attribute.  Use the IJpaFactory
	 * for creation so that extenders can create their own IJpaFactory instead of 
	 * creating their own attributeMappingProvider.
	 * @param attribute
	 * @param jpaFactory
	 */
	IJavaAttributeMapping buildMapping(Attribute attribute, IJpaFactory jpaFactory);

	DeclarationAnnotationAdapter declarationAnnotationAdapter();

}