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

Go to download

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

Utilities for Spring and Hibernate ORM 6.2 or newer

There is a newer version: 3.9.0

Show newest version

package io.hypersistence.utils.hibernate.id;

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

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import org.hibernate.annotations.IdGeneratorType;

/**
 * Meta annotation to use {@link BatchSequenceGenerator} as an identifier generator.
 * 
 * @author Philippe Marschall
 * @since 3.8.1
 */
@IdGeneratorType(BatchSequenceGenerator.class)
@Retention(RUNTIME)
@Target({ FIELD, METHOD })
public @interface BatchSequence {

    /**
     * Returns the name of the sequence to use.
     * 
     * @return the name of the sequence to use
     */
    String name();

    /**
     *  Returns how many sequence values to fetch at once.
     * 
     * @return how many sequence values to fetch at once, must be positive
     */
    int fetchSize() default BatchSequenceGenerator.DEFAULT_FETCH_SIZE;

    /**
     * Returns the catalog name of the sequence to use.
     * 
     * @return the catalog name of the sequence to use
     */
    String catalog() default "";

    /**
     * Returns the catalog name of the sequence to use.
     * 
     * @return the catalog name of the sequence to use
     */
    String schema() default "";

}