JpaEntityInformationSupport.java

/*
 * Copyright 2011-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.jpa.repository.support;

import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceUnitUtil;
import jakarta.persistence.metamodel.EntityType;
import jakarta.persistence.metamodel.ManagedType;
import jakarta.persistence.metamodel.Metamodel;

import org.springframework.data.domain.Persistable;
import org.springframework.data.jpa.repository.query.DefaultJpaEntityMetadata;
import org.springframework.data.jpa.repository.query.JpaEntityMetadata;
import org.springframework.data.repository.core.support.AbstractEntityInformation;
import org.springframework.util.Assert;

/**
 * Base class for {@link JpaEntityInformation} implementations to share common method implementations.
 *
 * @author Oliver Gierke
 * @author Mark Paluch
 * @author Greg Turnquist
 */
public abstract class JpaEntityInformationSupport<T, ID> extends AbstractEntityInformation<T, ID>
		implements JpaEntityInformation<T, ID> {

	private final JpaEntityMetadata<T> metadata;

	/**
	 * Creates a new {@link JpaEntityInformationSupport} with the given domain class.
	 *
	 * @param domainClass must not be {@literal null}.
	 */
	public JpaEntityInformationSupport(Class<T> domainClass) {
		this(new DefaultJpaEntityMetadata<>(domainClass));
	}

	/**
	 * Creates a new {@link JpaEntityInformationSupport} with the given {@link JpaEntityMetadata}.
	 *
	 * @param metadata must not be {@literal null}.
	 */
	public JpaEntityInformationSupport(JpaEntityMetadata<T> metadata) {
		super(metadata.getJavaType());
		this.metadata = metadata;
	}

	/**
	 * Creates a {@link JpaEntityInformation} for the given domain class and {@link EntityManager}.
	 *
	 * @param domainClass must not be {@literal null}.
	 * @param em must not be {@literal null}.
	 * @return
	 */
	public static <T> JpaEntityInformation<T, ?> getEntityInformation(Class<T> domainClass, EntityManager em) {

		Assert.notNull(domainClass, "Domain class must not be null");
		Assert.notNull(em, "EntityManager must not be null");

		return getEntityInformation(domainClass, em.getMetamodel(), em.getEntityManagerFactory().getPersistenceUnitUtil());
	}

	/**
	 * Creates a {@link JpaEntityInformation} for the given domain class and {@link Metamodel}.
	 *
	 * @param domainClass must not be {@literal null}.
	 * @param metamodel must not be {@literal null}.
	 * @param persistenceUnitUtil must not be {@literal null}.
	 * @return
	 * @since 4.0
	 */
	@SuppressWarnings({ "rawtypes", "unchecked" })
	public static <T> JpaEntityInformation<T, ?> getEntityInformation(Class<T> domainClass, Metamodel metamodel,
			PersistenceUnitUtil persistenceUnitUtil) {

		Assert.notNull(domainClass, "Domain class must not be null");
		Assert.notNull(metamodel, "Metamodel must not be null");

		ManagedType<T> type = metamodel.managedType(domainClass);

		if (type instanceof EntityType<T> entityType) {
			if (Persistable.class.isAssignableFrom(domainClass)) {
				return new JpaPersistableEntityInformation(entityType, metamodel, persistenceUnitUtil);
			} else {
				return new JpaMetamodelEntityInformation(entityType, metamodel, persistenceUnitUtil);
			}
		}

		if (Persistable.class.isAssignableFrom(domainClass)) {
			return new JpaPersistableEntityInformation(domainClass, metamodel, persistenceUnitUtil);
		} else {
			return new JpaMetamodelEntityInformation(domainClass, metamodel, persistenceUnitUtil);
		}
	}

	@Override
	public String getEntityName() {
		return metadata.getEntityName();
	}
}