org.hibernate.id.factory.IdentifierGeneratorFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* 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 .
*/
package org.hibernate.id.factory;
import java.util.Properties;
import org.hibernate.dialect.Dialect;
import org.hibernate.id.IdentifierGenerator;
import org.hibernate.type.Type;
/**
* Contract for a factory of {@link IdentifierGenerator} instances.
*
* @author Steve Ebersole
*/
public interface IdentifierGeneratorFactory {
/**
* Get the dialect.
*
* @return the dialect
*/
public Dialect getDialect();
/**
* Allow injection of the dialect to use.
*
* @param dialect The dialect
*
* @deprecated The intention is that Dialect should be required to be specified up-front and it would then get
* ctor injected.
*/
@Deprecated
public void setDialect(Dialect dialect);
/**
* Given a strategy, retrieve the appropriate identifier generator instance.
*
* @param strategy The generation strategy.
* @param type The mapping type for the identifier values.
* @param config Any configuraion properties given in the generator mapping.
*
* @return The appropriate generator instance.
*/
public IdentifierGenerator createIdentifierGenerator(String strategy, Type type, Properties config);
/**
* Retrieve the class that will be used as the {@link IdentifierGenerator} for the given strategy.
*
* @param strategy The strategy
* @return The generator class.
*/
public Class getIdentifierGeneratorClass(String strategy);
}