org.springframework.data.cassandra.core.mapping.UserTypeResolver Maven / Gradle / Ivy

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

Cassandra support for Spring Data

There is a newer version: 4.3.2

Show newest version

/*
 * Copyright 2016-2019 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.cassandra.core.mapping;

import org.springframework.data.cassandra.core.cql.CqlIdentifier;
import org.springframework.lang.Nullable;

import com.datastax.driver.core.UserType;

/**
 * Strategy interface to resolve {@link UserType} by {@link String name}.
 *
 * @author Mark Paluch
 * @see com.datastax.driver.core.DataType
 * @see org.springframework.data.cassandra.core.cql.CqlIdentifier
 * @since 1.5
 */
@FunctionalInterface
public interface UserTypeResolver {

	/**
	 * Resolve a {@link UserType} by {@link String name}.
	 *
	 * @param typeName {@link String name} of the {@link UserType} to resolve; must not be {@literal null}.
	 * @return the resolved {@link UserType} or {@literal null} if not found.
	 * @see org.springframework.data.cassandra.core.cql.CqlIdentifier
	 * @see com.datastax.driver.core.DataType
	 */
	@Nullable
	UserType resolveType(CqlIdentifier typeName);

}