/*
* Copyright 2014-2021 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.mapping.model;
import org.springframework.core.convert.ConversionService;
import org.springframework.data.mapping.PersistentProperty;
import org.springframework.data.mapping.PersistentPropertyAccessor;
import org.springframework.data.mapping.PersistentPropertyPath;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
PersistentPropertyAccessor
that potentially converts the value handed to setProperty(PersistentProperty, Object)
to the type of the PersistentProperty
using a ConversionService
. Exposes getProperty(PersistentProperty, Class)
to allow obtaining the value of a property in a type the ConversionService
can convert the raw type to. Author: Oliver Gierke, Mark Paluch
/**
* {@link PersistentPropertyAccessor} that potentially converts the value handed to
* {@link #setProperty(PersistentProperty, Object)} to the type of the {@link PersistentProperty} using a
* {@link ConversionService}. Exposes {@link #getProperty(PersistentProperty, Class)} to allow obtaining the value of a
* property in a type the {@link ConversionService} can convert the raw type to.
*
* @author Oliver Gierke
* @author Mark Paluch
*/
public class ConvertingPropertyAccessor<T> extends SimplePersistentPropertyPathAccessor<T> {
private final PersistentPropertyAccessor<T> accessor;
private final ConversionService conversionService;
Creates a new ConvertingPropertyAccessor
for the given delegate PersistentPropertyAccessor
and ConversionService
. Params: - accessor – must not be null.
- conversionService – must not be null.
/**
* Creates a new {@link ConvertingPropertyAccessor} for the given delegate {@link PersistentPropertyAccessor} and
* {@link ConversionService}.
*
* @param accessor must not be {@literal null}.
* @param conversionService must not be {@literal null}.
*/
public ConvertingPropertyAccessor(PersistentPropertyAccessor<T> accessor, ConversionService conversionService) {
super(accessor);
Assert.notNull(accessor, "PersistentPropertyAccessor must not be null!");
Assert.notNull(conversionService, "ConversionService must not be null!");
this.accessor = accessor;
this.conversionService = conversionService;
}
/*
* (non-Javadoc)
* @see org.springframework.data.mapping.PersistentPropertyAccessor#setProperty(org.springframework.data.mapping.PersistentProperty, java.lang.Object)
*/
@Override
public void setProperty(PersistentProperty<?> property, @Nullable Object value) {
accessor.setProperty(property, convertIfNecessary(value, property.getType()));
}
/*
* (non-Javadoc)
* @see org.springframework.data.mapping.PersistentPropertyAccessor#setProperty(org.springframework.data.mapping.PersistentPropertyPath, java.lang.Object)
*/
@Override
public void setProperty(PersistentPropertyPath<? extends PersistentProperty<?>> path, @Nullable Object value) {
Object converted = convertIfNecessary(value, path.getRequiredLeafProperty().getType());
super.setProperty(path, converted);
}
Returns the value of the given PersistentProperty
converted to the given type. Params: - property – must not be null.
- targetType – must not be null.
Returns:
/**
* Returns the value of the given {@link PersistentProperty} converted to the given type.
*
* @param property must not be {@literal null}.
* @param targetType must not be {@literal null}.
* @return
*/
@Nullable
public <S> S getProperty(PersistentProperty<?> property, Class<S> targetType) {
Assert.notNull(property, "PersistentProperty must not be null!");
Assert.notNull(targetType, "Target type must not be null!");
return convertIfNecessary(getProperty(property), targetType);
}
/*
* (non-Javadoc)
* @see org.springframework.data.mapping.model.SimplePersistentPropertyPathAccessor#getTypedProperty(org.springframework.data.mapping.PersistentProperty, java.lang.Class)
*/
@Nullable
@Override
protected <S> S getTypedProperty(PersistentProperty<?> property, Class<S> type) {
return convertIfNecessary(super.getTypedProperty(property, type), type);
}
Triggers the conversion of the source value into the target type unless the value already is a value of given
target type.
Params: - source – can be null.
- type – must not be null.
Returns:
/**
* Triggers the conversion of the source value into the target type unless the value already is a value of given
* target type.
*
* @param source can be {@literal null}.
* @param type must not be {@literal null}.
* @return
*/
@Nullable
@SuppressWarnings("unchecked")
private <S> S convertIfNecessary(@Nullable Object source, Class<S> type) {
return (S) (source == null //
? null //
: type.isAssignableFrom(source.getClass()) //
? source //
: conversionService.convert(source, type));
}
}