/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.boot.model;

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.SequenceGenerator;
import javax.persistence.TableGenerator;

Strategy for interpreting identifier generator related information.
Author:
Steve Ebersole/**
 * Strategy for interpreting identifier generator related information.
 *
 * @author Steve Ebersole
 */
public interface IdGeneratorStrategyInterpreter {
	interface GeneratorNameDeterminationContext {
		
The Java type of the attribute defining the id whose value is to
be generated.
/**
		 * The Java type of the attribute defining the id whose value is to
		 * be generated.
		 */
		Class getIdType();

		
The GeneratedValue.generator() name. /**
		 * The {@link GeneratedValue#generator()} name.
		 */
		String getGeneratedValueGeneratorName();
	}

	
Determine the name of the generator which should be used based on the GenerationType, returning null to indicate that this interpreter did not have a match and that any additional resolutions should be performed. 
Params:
generationType – The GeneratedValue.strategy value
context – The context for resolution (method parameter object)
API Note:
Not really a great name as it is a bit confusing. What is really being resolved here is the name of the IdentifierGenerator to use. This is (generally) different than the GeneratedValue.generator() name for the GeneratedValue that is the source of the passed GenerationType. For implementations that need it, the GeneratedValue.generator() is passed as part of the `context`.
Returns:
The IdentifierGenerator name (FQN, short name, etc)/**
	 * Determine the name of the generator which should be used based on the
	 * GenerationType, returning {@code null} to indicate that this interpreter
	 * did not have a match and that any additional resolutions should be performed.
	 *
	 * @apiNote Not really a great name as it is a bit confusing.  What is really
	 * being resolved here is the name of the
	 * {@link org.hibernate.id.IdentifierGenerator} to use.  This is (generally)
	 * different than the {@link GeneratedValue#generator()} name for the
	 * {@link GeneratedValue} that is the source of the passed {@link GenerationType}.
	 * For implementations that need it, the {@link GeneratedValue#generator()}
	 * is passed as part of the `context`.
	 *
	 * @param generationType The {@link javax.persistence.GeneratedValue#strategy} value
	 * @param context The context for resolution (method parameter object)
	 *
	 * @return The {@link org.hibernate.id.IdentifierGenerator} name (FQN, short name, etc)
	 */
	String determineGeneratorName(GenerationType generationType, GeneratorNameDeterminationContext context);

	
Extract the IdentifierGeneratorDefinition related to the given TableGenerator annotation
Params:
tableGeneratorAnnotation – The annotation
definitionBuilder – The IdentifierGeneratorDefinition builder to which to apply
any interpreted/extracted configuration/**
	 * Extract the IdentifierGeneratorDefinition related to the given TableGenerator annotation
	 *
	 * @param tableGeneratorAnnotation The annotation
	 * @param definitionBuilder The IdentifierGeneratorDefinition builder to which to apply
	 * any interpreted/extracted configuration
	 */
	void interpretTableGenerator(TableGenerator tableGeneratorAnnotation, IdentifierGeneratorDefinition.Builder definitionBuilder);

	
Extract the IdentifierGeneratorDefinition related to the given SequenceGenerator annotation
Params:
sequenceGeneratorAnnotation – The annotation
definitionBuilder – The IdentifierGeneratorDefinition builder to which to apply
any interpreted/extracted configuration/**
	 * Extract the IdentifierGeneratorDefinition related to the given SequenceGenerator annotation
	 *
	 * @param sequenceGeneratorAnnotation The annotation
	 * @param definitionBuilder The IdentifierGeneratorDefinition builder to which to apply
	 * any interpreted/extracted configuration
	 */
	void interpretSequenceGenerator(SequenceGenerator sequenceGeneratorAnnotation, IdentifierGeneratorDefinition.Builder definitionBuilder);
}