org.springframework.data.convert.PropertyValueConversions Maven / Gradle / Ivy
/*
* Copyright 2022-2024 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.convert;
import java.util.function.Consumer;
import org.springframework.data.mapping.PersistentProperty;
/**
* {@link PropertyValueConversions} provides access to {@link PropertyValueConverter converters} that may only be
* applied to a specific {@link PersistentProperty property}. Other than
* {@link org.springframework.core.convert.converter.Converter converters} registered in {@link CustomConversions},
* the {@link PersistentProperty property} based variants accept and allow returning {@literal null} values
* and provide access to a store-specific {@link ValueConversionContext conversion context}.
*
* @author Christoph Strobl
* @since 2.7
* @currentBook The Desert Prince - Peter V. Brett
*/
public interface PropertyValueConversions {
/**
* Check if a {@link PropertyValueConverter converter} is registered for
* the given {@link PersistentProperty property}.
*
* @param property {@link PersistentProperty} to evaluate; must not be {@literal null}.
* @return {@literal true} if a specific {@link PropertyValueConverter converter} is registered for
* the given {@link PersistentProperty}.
* @see PersistentProperty
*/
boolean hasValueConverter(PersistentProperty property);
/**
* Get the {@link PropertyValueConverter converter} registered for the given {@link PersistentProperty property}.
*
* @param property {@link PersistentProperty} used to look up the registered {@link PropertyValueConverter};
* must not be {@literal null}.
* @param domain-specific type
* @param store-native type
* @param conversion context type
* @return the {@link PropertyValueConverter} registered for the given {@link PersistentProperty};
* never {@literal null}.
* @throws IllegalArgumentException if no {@link PropertyValueConverter} was registered for
* the given {@link PersistentProperty}.
* @see #hasValueConverter(PersistentProperty)
* @see PropertyValueConverter
* @see PersistentProperty
*/
, VCC extends ValueConversionContext> PropertyValueConverter getValueConverter(
P property);
/**
* Helper method used to create a {@link PropertyValueConversions} instance with the configured
* {@link PropertyValueConverter converters} provided by the {@link Consumer callback}.
*
* @see PropertyValueConverterRegistrar
* @see PropertyValueConversions
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
static > PropertyValueConversions simple(
Consumer> config) {
SimplePropertyValueConversions conversions = new SimplePropertyValueConversions();
PropertyValueConverterRegistrar registrar = new PropertyValueConverterRegistrar();
config.accept(registrar);
conversions.setValueConverterRegistry(registrar.buildRegistry());
conversions.afterPropertiesSet();
return conversions;
}
}