Package org.hibernate.id

Interface Configurable

All Known Subinterfaces:

IdentifierGenerator, OptimizableGenerator, PersistentIdentifierGenerator, PostInsertIdentifierGenerator

All Known Implementing Classes:

AbstractPostInsertGenerator, AbstractUUIDGenerator, Assigned, CompositeNestedGeneratedValueGenerator, ForeignGenerator, GUIDGenerator, IdentityGenerator, IncrementGenerator, OrderedSequenceGenerator, SelectGenerator, SequenceStyleGenerator, TableGenerator, UUIDGenerator, UUIDHexGenerator

public interface Configurable

A Generator that supports "configuration".

Author:

Gavin King, Steve Ebersole

Method Summary

Modifier and Type	Method	Description
void	configure(Type type, Properties parameters, ServiceRegistry serviceRegistry)	Configure this instance, given the value of parameters specified by the user as XML <param> elements and @Parameter annotations.
default void	create(GeneratorCreationContext creationContext)	Deprecated, for removal: This API element is subject to removal in a future version. Added in 6.6 as a short-term work-around, but should really use on of the alternatives discussed at Configurable.
default void	initialize(SqlStringGenerationContext context)	Initializes this instance, pre-generating SQL if necessary.

Method Details

create

@Deprecated(forRemoval=true)
default void create(GeneratorCreationContext creationContext)
             throws MappingException

Deprecated, for removal: This API element is subject to removal in a future version.

Added in 6.6 as a short-term work-around, but should really use on of the alternatives discussed at Configurable. See HHH-18615.

Called before configure(Type, Properties, ServiceRegistry), with an instance of GeneratorCreationContext.

Throws:

MappingException

Since:

6.6

configure

void configure(Type type,
 Properties parameters,
 ServiceRegistry serviceRegistry)
        throws MappingException

Configure this instance, given the value of parameters specified by the user as XML <param> elements and @Parameter annotations.

This method is called just once, following instantiation. If this instance also implements ExportableProducer, then this method is always called before ExportableProducer.registerExportables(Database),

Parameters:

type - The id property type descriptor

parameters - param values, keyed by parameter name

serviceRegistry - Access to service that may be needed.

Throws:

MappingException - when there's something wrong with the given parameters

initialize

default void initialize(SqlStringGenerationContext context)

Initializes this instance, pre-generating SQL if necessary.

If this instance also implements ExportableProducer, then this method is always called after ExportableProducer.registerExportables(Database), and before first use.

Parameters:

context - A context to help generate SQL strings