io.hypersistence.utils.hibernate.id.Tsid Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hypersistence-utils-hibernate-63 Show documentation

Utilities for Spring and Hibernate ORM 6.3, 6.4, and 6.5

There is a newer version: 3.8.3

Show newest version

package io.hypersistence.utils.hibernate.id;

import io.hypersistence.tsid.TSID;
import org.hibernate.annotations.IdGeneratorType;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.function.Supplier;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;

/**
 * The {@code @Tsid} annotation can be added next to the entity identifier,
 * therefore indicating that the identifier will be assigned a time-sorted
 * identifier that's automatically generated.
 *
 * You can use the {@code @Tsid} annotation to annotate {@link Long}, {@link String},
 * or {@link TSID} entity identifiers.
 *
 * @author Vlad Mihalcea
 */
@IdGeneratorType(TsidGenerator.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({FIELD, METHOD})
public @interface Tsid {

    /**
     * Specify the class that can provide the custom {@link TSID.Factory}.
     * By default, the {@link FactorySupplier} is used.
     *
     * @return the {@link TSID.Factory} supplier.
     */
    Class> value() default FactorySupplier.class;

    class FactorySupplier implements Supplier {

        public static final FactorySupplier INSTANCE = new FactorySupplier();

        private TSID.Factory tsidFactory = TSID.Factory.builder()
            .withRandomFunction(TSID.Factory.THREAD_LOCAL_RANDOM_FUNCTION)
            .build();

        @Override
        public TSID.Factory get() {
            return tsidFactory;
        }
    }
}