Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-6970 - Expand notion of "natural id mutability" to ternary value

This commit is contained in:
Steve Ebersole 2012-01-19 10:12:17 -06:00
parent 57e9b48587
commit 73dec965a0
2 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
hibernate-core/src/main/java/org/hibernate/NaturalIdMutability.java
View File

@ -27,6 +27,8 @@ package org.hibernate;
* Possible values regarding the mutability of a natural id. * Possible values regarding the mutability of a natural id.
* *
* @author Steve Ebersole * @author Steve Ebersole
*
* @see org.hibernate.annotations.NaturalId
*/ */
public enum NaturalIdMutability { public enum NaturalIdMutability {
/** /**
@ -34,12 +36,14 @@ public enum NaturalIdMutability {
* the entity to the database. Also, it will invalidate any caching when such a change is detected. * the entity to the database. Also, it will invalidate any caching when such a change is detected.
*/ */
MUTABLE, MUTABLE,
/** /**
* The natural id is immutable. Hibernate will ignore any changes in the natural id value when flushing updates * The natural id is immutable. Hibernate will ignore any changes in the natural id value when flushing updates
* to the entity to the database. Additionally Hibernate <b>will not</b> check with the database to check if the * to the entity to the database. Additionally Hibernate <b>will not</b> check with the database to check if the
* natural id values change there. Essentially the user is assuring Hibernate that the values will not change. * natural id values change there. Essentially the user is assuring Hibernate that the values will not change.
*/ */
IMMUTABLE, IMMUTABLE,
/** /**
* The natural id is immutable. Hibernate will ignore any changes in the natural id value when flushing updates * The natural id is immutable. Hibernate will ignore any changes in the natural id value when flushing updates
* to the entity to the database. However, Hibernate <b>will</b> check with the database to check if the natural * to the entity to the database. However, Hibernate <b>will</b> check with the database to check if the natural
@ -50,5 +54,12 @@ public enum NaturalIdMutability {
* as such. The overhead of maintaining caching of natural ids in these cases is far greater than the benefit * as such. The overhead of maintaining caching of natural ids in these cases is far greater than the benefit
* from such caching. In such cases, a database index is a much better solution. * from such caching. In such cases, a database index is a much better solution.
*/ */
IMMUTABLE_CHECKED IMMUTABLE_CHECKED,
/**
* @deprecated Added in deprecated form solely to allow seamless working until the deprecated attribute
* {@link org.hibernate.annotations.NaturalId#mutable()} can be removed.
*/
@Deprecated
UNSPECIFIED
} }

8
hibernate-core/src/main/java/org/hibernate/annotations/NaturalId.java
View File

@ -54,9 +54,13 @@ public @interface NaturalId {
boolean mutable() default false; boolean mutable() default false;
/** /**
* The mutability behavior of this natural id * The mutability behavior of this natural id.
*
* Note: the current default value is the {@link NaturalIdMutability#UNSPECIFIED} value which was added
* in deprecated form until the deprecated {@link #mutable()} attribute here can be removed. This lets existing
* applications continue to work seamlessly using their existing natural id annotations.
* *
* @return The mutability behavior. * @return The mutability behavior.
*/ */
NaturalIdMutability mutability(); NaturalIdMutability mutability() default NaturalIdMutability.UNSPECIFIED;
} }