Top Description Inners Fields Constructors Methods
org.hibernate.boot.model

public Class IdentifierGeneratorDefinition

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, java.lang.annotation.Annotation, java.util.Collections, .HashMap, .Map, .Objects, org.hibernate.AnnotationException, .AssertionFailure, .Internal, org.hibernate.boot.internal.GenerationStrategyInterpreter, org.hibernate.id.IdentifierGenerator, jakarta.persistence.GenerationType, .Index, .SequenceGenerator, .TableGenerator, .UniqueConstraint

Models the definition of an identifier generator

Implementation Specification

Should be immutable.

Authors
Steve Ebersole, Emmanuel Bernard, Strong Liu

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final String
private final Map<String, String>
private final String

Constructor Summary

AccessConstructor and Description
public
IdentifierGeneratorDefinition(final String name, final String strategy, final Map<String, String> parameters)

public
IdentifierGeneratorDefinition(final String name, final Map<String, String> parameters)

public
public

Method Summary

Modifier and TypeMethod and Description
private static IdentifierGeneratorDefinition
private static IdentifierGeneratorDefinition
public static IdentifierGeneratorDefinition
createImplicit(String name, Class<?> idType, String generatorName, GenerationType generationType)

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String

Returns:

generator name
getName
()

public Map<String, String>

Returns:

generator configuration parameters
getParameters
()

public String

Returns:

identifier generator strategy
getStrategy
()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name
parametersback to summary
private final Map<String, String> parameters
strategyback to summary
private final String strategy

Constructor Detail

IdentifierGeneratorDefinitionback to summary
public IdentifierGeneratorDefinition(final String name, final String strategy, final Map<String, String> parameters)
IdentifierGeneratorDefinitionback to summary
public IdentifierGeneratorDefinition(final String name, final Map<String, String> parameters)
IdentifierGeneratorDefinitionback to summary
public IdentifierGeneratorDefinition(String name)
IdentifierGeneratorDefinitionback to summary
public IdentifierGeneratorDefinition(String name, String strategy)

Method Detail

buildSequenceGeneratorDefinitionback to summary
private static IdentifierGeneratorDefinition buildSequenceGeneratorDefinition(String name)
buildTableGeneratorDefinitionback to summary
private static IdentifierGeneratorDefinition buildTableGeneratorDefinition(String name)
createImplicitback to summary
public static IdentifierGeneratorDefinition createImplicit(String name, Class<?> idType, String generatorName, GenerationType generationType)
Annotations
@Internal
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getNameback to summary
public String getName()
Returns:String

generator name

getParametersback to summary
public Map<String, String> getParameters()
Returns:Map<String, String>

generator configuration parameters

getStrategyback to summary
public String getStrategy()
Returns:String

identifier generator strategy

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.hibernate.boot.model back to summary

public Class IdentifierGeneratorDefinition.Builder

extends Object
Class Inheritance
  • java.lang.Object
  • org.hibernate.boot.model.IdentifierGeneratorDefinition.Builder

Field Summary

Modifier and TypeField and Description
private String
private Map<String, String>
private String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
addParam(String name, String value)

public void
addParams(Map<String, String> parameters)

public IdentifierGeneratorDefinition
public String
public String
private Map<String, String>
public void
public void
setStrategy(String strategy)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nameback to summary
private String name
parametersback to summary
private Map<String, String> parameters
strategyback to summary
private String strategy

Constructor Detail

Builderback to summary
public Builder()

Method Detail

addParamback to summary
public void addParam(String name, String value)
addParamsback to summary
public void addParams(Map<String, String> parameters)
buildback to summary
public IdentifierGeneratorDefinition build()
getNameback to summary
public String getName()
getStrategyback to summary
public String getStrategy()
parametersback to summary
private Map<String, String> parameters()
setNameback to summary
public void setName(String name)
setStrategyback to summary
public void setStrategy(String strategy)