org.springframework.data.relational.RelationalManagedTypes Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-relational Show documentation

Spring Data Relational support

There is a newer version: 3.3.2

Show newest version

/*
 * Copyright 2022-2023 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.relational;

import java.util.Arrays;
import java.util.function.Consumer;

import org.springframework.data.domain.ManagedTypes;

/**
 * Relational-specific extension to {@link ManagedTypes}.
 *
 * @author Mark Paluch
 * @since 3.0
 */
public final class RelationalManagedTypes implements ManagedTypes {

	private final ManagedTypes delegate;

	private RelationalManagedTypes(ManagedTypes types) {
		this.delegate = types;
	}

	/**
	 * Wraps an existing {@link ManagedTypes} object with {@link RelationalManagedTypes}.
	 *
	 * @param managedTypes
	 * @return
	 */
	public static RelationalManagedTypes from(ManagedTypes managedTypes) {
		return new RelationalManagedTypes(managedTypes);
	}

	/**
	 * Factory method used to construct {@link RelationalManagedTypes} from the given array of {@link Class types}.
	 *
	 * @param types array of {@link Class types} used to initialize the {@link ManagedTypes}; must not be {@literal null}.
	 * @return new instance of {@link RelationalManagedTypes} initialized from {@link Class types}.
	 */
	public static RelationalManagedTypes from(Class... types) {
		return fromIterable(Arrays.asList(types));
	}

	/**
	 * Factory method used to construct {@link RelationalManagedTypes} from the given, required {@link Iterable} of
	 * {@link Class types}.
	 *
	 * @param types {@link Iterable} of {@link Class types} used to initialize the {@link ManagedTypes}; must not be
	 *          {@literal null}.
	 * @return new instance of {@link RelationalManagedTypes} initialized the given, required {@link Iterable} of
	 *         {@link Class types}.
	 */
	public static RelationalManagedTypes fromIterable(Iterable> types) {
		return from(ManagedTypes.fromIterable(types));
	}

	/**
	 * Factory method to return an empty {@link RelationalManagedTypes} object.
	 *
	 * @return an empty {@link RelationalManagedTypes} object.
	 */
	public static RelationalManagedTypes empty() {
		return from(ManagedTypes.empty());
	}

	@Override
	public void forEach(Consumer> action) {
		delegate.forEach(action);
	}
}