org.hibernate.annotations.GenerationTime Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of beangle-hibernate-core Show documentation

Hibernate Orm Core Shade,Support Scala Collection

There is a newer version: 6.6.2.Final

Show newest version

/*
 * 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 .
 */
package org.hibernate.annotations;

import java.util.EnumSet;

import org.hibernate.AssertionFailure;
import org.hibernate.Internal;
import org.hibernate.generator.EventType;
import org.hibernate.generator.EventTypeSets;
import org.hibernate.tuple.GenerationTiming;

/**
 * Represents a class of events involving interaction with the database
 * that causes generation of a new value. Intended for use with the
 * {@link Generated} and {@link CurrentTimestamp} annotations.
 *
 * @author Emmanuel Bernard
 *
 * @see Generated
 * @see CurrentTimestamp
 *
 * @deprecated use {@link EventType} and {@link EventTypeSets} instead
 */
@Deprecated(since = "6.2")
public enum GenerationTime {
	/**
	 * Indicates that a value is never generated.
	 */
	NEVER,
	/**
	 * Indicates that a new value is generated on insert.
	 */
	INSERT,
	/**
	 * Indicates that a new value is generated on update.
	 *
	 * @since 6.2
	 */
	UPDATE,
	/**
	 * Indicates that a new value is generated on insert and on update.
	 */
	ALWAYS;

	public EnumSet eventTypes() {
		switch (this) {
			case NEVER:
				return EventTypeSets.NONE;
			case ALWAYS:
				return EventTypeSets.ALL;
			case INSERT:
				return EventTypeSets.INSERT_ONLY;
			case UPDATE:
				return EventTypeSets.UPDATE_ONLY;
			default:
				throw new AssertionFailure("unknown event");
		}
	}

	/**
	 * @return the equivalent instance of {@link GenerationTiming}
	 *
	 * @deprecated Needed for backwards compatibility until the deprecated, legacy
	 * generation stuff can be removed
	 */
	@Internal @Deprecated(forRemoval = true)
	public GenerationTiming getEquivalent() {
		switch (this) {
			case ALWAYS:
				return GenerationTiming.ALWAYS;
			case INSERT:
				return GenerationTiming.INSERT;
			case UPDATE:
				return GenerationTiming.UPDATE;
			case NEVER:
				return GenerationTiming.NEVER;
			default:
				throw new AssertionFailure("unknown event");
		}
	}
}