HHH-11186 - Add examples for all Hibernate annotations

documentation/src/main/asciidoc/userguide/appendices/Annotations.adoc

@@ -1275,14 +1275,14 @@ The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibern
 
 The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/Type.html[`@Type`] annotation is used to specify the Hibernate https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/type/Type.html[`@Type`] used by the current annotated basic attribute.
 
-See the <<chapters/domain/basic_types.adoc#collections-comma-delimited-collection-example, `@Type` mapping>> section for more info.
+See the <<chapters/domain/basic_types.adoc#basic-custom-type-BitSetType-mapping-example, `@Type` mapping>> section for more info.
 
 [[annotations-hibernate-typedef]]
 ==== `@TypeDef`
 
 The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/TypeDef.html[`@TypeDef`] annotation is used to specify a https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/type/Type.html[`@Type`] definition which can later be reused for multiple basic attribute mappings.
 
-//TODO: Add example
+See the <<chapters/domain/basic_types.adoc#basic-custom-type-BitSetTypeDef-mapping-example, `@TypeDef` mapping>> section for more info.
 
 [[annotations-hibernate-typedefs]]
 ==== `@TypeDefs`

documentation/src/main/asciidoc/userguide/chapters/domain/basic_types.adoc

@@ -313,6 +313,17 @@ include::{sourcedir}/basic/BitSetTypeTest.java[tags=basic-custom-type-BitSetType
 ----
 ====
 
+Alternatively, use can use a `@TypeDef` ans skip the registration phase:
+
+[[basic-custom-type-BitSetTypeDef-mapping-example]]
+.Using `@TypeDef` to register a custom Type
+====
+[source, JAVA, indent=0]
+----
+include::{sourcedir}/basic/BitSetTypeDefTest.java[tags=basic-custom-type-BitSetTypeDef-mapping-example]
+----
+====
+
 To validate this new `BasicType` implementation, we can test it as follows:
 
 [[basic-custom-type-BitSetType-persistence-example]]

documentation/src/test/java/org/hibernate/userguide/mapping/basic/BitSetTypeDefTest.java

@@ -0,0 +1,86 @@
+/*
+ * 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.userguide.mapping.basic;
+
+import java.util.BitSet;
+import javax.persistence.Entity;
+import javax.persistence.Id;
+
+import org.hibernate.annotations.Type;
+import org.hibernate.annotations.TypeDef;
+import org.hibernate.cfg.Configuration;
+
+import org.hibernate.testing.junit4.BaseCoreFunctionalTestCase;
+import org.junit.Test;
+
+import static org.hibernate.testing.transaction.TransactionUtil.doInHibernate;
+import static org.junit.Assert.assertEquals;
+
+/**
+ * @author Vlad Mihalcea
+ */
+public class BitSetTypeDefTest extends BaseCoreFunctionalTestCase {
+
+	@Override
+	protected Class<?>[] getAnnotatedClasses() {
+		return new Class<?>[] {
+			Product.class
+		};
+	}
+
+	@Test
+	public void test() {
+
+		//tag::basic-custom-type-BitSetTypeDef-persistence-example[]
+		BitSet bitSet = BitSet.valueOf( new long[] {1, 2, 3} );
+
+		doInHibernate( this::sessionFactory, session -> {
+			Product product = new Product( );
+			product.setId( 1 );
+			product.setBitSet( bitSet );
+			session.persist( product );
+		} );
+
+		doInHibernate( this::sessionFactory, session -> {
+			Product product = session.get( Product.class, 1 );
+			assertEquals(bitSet, product.getBitSet());
+		} );
+		//end::basic-custom-type-BitSetTypeDef-persistence-example[]
+	}
+
+	//tag::basic-custom-type-BitSetTypeDef-mapping-example[]
+	@Entity(name = "Product")
+	@TypeDef(
+		name = "bitset",
+		defaultForType = BitSet.class,
+		typeClass = BitSetType.class
+	)
+	public static class Product {
+
+		@Id
+		private Integer id;
+
+		private BitSet bitSet;
+
+		public Integer getId() {
+			return id;
+		}
+
+		public void setId(Integer id) {
+			this.id = id;
+		}
+
+		public BitSet getBitSet() {
+			return bitSet;
+		}
+
+		public void setBitSet(BitSet bitSet) {
+			this.bitSet = bitSet;
+		}
+	}
+	//end::basic-custom-type-BitSetTypeDef-mapping-example[]
+}