HHH-17441 - Deprecate @Comment

This commit is contained in:
Steve Ebersole 2023-11-19 06:44:05 -06:00
parent 48451d2e2f
commit ddae751b5f
3 changed files with 10 additions and 1 deletions

View File

@ -45,10 +45,11 @@ tasks.named( "javadoc", Javadoc ) {
linksOffline 'https://www.javadoc.io/doc/javax.cache/cache-api/1.0.0/', "${project.rootDir}/javadoc/javax-cache-1.0" linksOffline 'https://www.javadoc.io/doc/javax.cache/cache-api/1.0.0/', "${project.rootDir}/javadoc/javax-cache-1.0"
tags( tags(
'todo:X',
'apiNote:a:API Note:', 'apiNote:a:API Note:',
'implSpec:a:Implementation Specification:', 'implSpec:a:Implementation Specification:',
'implNote:a:Implementation Note:', 'implNote:a:Implementation Note:',
'todo:X',
'remove:a:Removal (deprecation):',
'settingDefault:f:Default Value:' 'settingDefault:f:Default Value:'
) )

View File

@ -6,6 +6,7 @@
*/ */
package org.hibernate.annotations; package org.hibernate.annotations;
import org.hibernate.Remove;
import org.hibernate.binder.internal.CommentBinder; import org.hibernate.binder.internal.CommentBinder;
import java.lang.annotation.Repeatable; import java.lang.annotation.Repeatable;
@ -47,12 +48,15 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
* *
* @author Yanming Zhou * @author Yanming Zhou
* @author Gavin King * @author Gavin King
*
* @remove JPA 3.2 adds a comment attribute to {@linkplain jakarta.persistence.Table}
*/ */
@TypeBinderType(binder = CommentBinder.class) @TypeBinderType(binder = CommentBinder.class)
@AttributeBinderType(binder = CommentBinder.class) @AttributeBinderType(binder = CommentBinder.class)
@Target({METHOD, FIELD, TYPE}) @Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME) @Retention(RUNTIME)
@Repeatable(Comments.class) @Repeatable(Comments.class)
@Remove
public @interface Comment { public @interface Comment {
/** /**
* The text of the comment. * The text of the comment.

View File

@ -6,6 +6,7 @@
*/ */
package org.hibernate.annotations; package org.hibernate.annotations;
import org.hibernate.Remove;
import org.hibernate.binder.internal.CommentBinder; import org.hibernate.binder.internal.CommentBinder;
import org.hibernate.binder.internal.CommentsBinder; import org.hibernate.binder.internal.CommentsBinder;
@ -24,11 +25,14 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
* they must have distinct {@link Comment#on() on} members. * they must have distinct {@link Comment#on() on} members.
* *
* @author Gavin King * @author Gavin King
*
* @remove JPA 3.2 adds a comment attribute to {@linkplain jakarta.persistence.Table}
*/ */
@TypeBinderType(binder = CommentsBinder.class) @TypeBinderType(binder = CommentsBinder.class)
@AttributeBinderType(binder = CommentsBinder.class) @AttributeBinderType(binder = CommentsBinder.class)
@Target({METHOD, FIELD, TYPE}) @Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME) @Retention(RUNTIME)
@Remove
public @interface Comments { public @interface Comments {
Comment[] value(); Comment[] value();
} }