org.springframework.data.r2dbc.dialect.Bindings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-r2dbc-dsl Show documentation
Show all versions of spring-data-r2dbc-dsl Show documentation
Spring Data DSL module for Web querying and Criteria building
/*
* Copyright 2019-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.r2dbc.dialect;
import io.r2dbc.spi.Statement;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Spliterator;
import java.util.function.Consumer;
import org.springframework.data.util.Streamable;
import org.springframework.lang.Nullable;
import org.springframework.r2dbc.core.binding.BindMarker;
import org.springframework.r2dbc.core.binding.BindMarkers;
import org.springframework.r2dbc.core.binding.BindTarget;
import org.springframework.util.Assert;
/**
* Value object representing value and {@literal null} bindings for a {@link Statement} using {@link BindMarkers}.
* Bindings are typically immutable.
*
* @author Mark Paluch
* @deprecated since 1.2 in favor of Spring R2DBC. Use {@link org.springframework.r2dbc.core.binding.Bindings} instead.
*/
@Deprecated
public class Bindings implements Streamable {
private static final Bindings EMPTY = new Bindings();
private final Map bindings;
/**
* Create empty {@link Bindings}.
*/
public Bindings() {
this.bindings = Collections.emptyMap();
}
/**
* Create {@link Bindings} from a {@link Map}.
*
* @param bindings must not be {@literal null}.
*/
public Bindings(Collection bindings) {
Assert.notNull(bindings, "Bindings must not be null");
Map mapping = new LinkedHashMap<>(bindings.size());
bindings.forEach(it -> mapping.put(it.getBindMarker(), it));
this.bindings = mapping;
}
Bindings(Map bindings) {
this.bindings = bindings;
}
/**
* Create a new, empty {@link Bindings} object.
*
* @return a new, empty {@link Bindings} object.
*/
public static Bindings empty() {
return EMPTY;
}
protected Map getBindings() {
return this.bindings;
}
/**
* Merge this bindings with an other {@link Bindings} object and create a new merged {@link Bindings} object.
*
* @param left the left object to merge with.
* @param right the right object to merge with.
* @return a new, merged {@link Bindings} object.
*/
public static Bindings merge(Bindings left, Bindings right) {
Assert.notNull(left, "Left side Bindings must not be null");
Assert.notNull(right, "Right side Bindings must not be null");
List result = new ArrayList<>(left.getBindings().size() + right.getBindings().size());
result.addAll(left.getBindings().values());
result.addAll(right.getBindings().values());
return new Bindings(result);
}
/**
* Merge this bindings with an other {@link Bindings} object and create a new merged {@link Bindings} object.
*
* @param other the object to merge with.
* @return a new, merged {@link Bindings} object.
*/
public Bindings and(Bindings other) {
return merge(this, other);
}
/**
* Apply the bindings to a {@link BindTarget}.
*
* @param bindTarget the target to apply bindings to.
*/
public void apply(BindTarget bindTarget) {
Assert.notNull(bindTarget, "BindTarget must not be null");
this.bindings.forEach((marker, binding) -> binding.apply(bindTarget));
}
/**
* Performs the given action for each binding of this {@link Bindings} until all bindings have been processed or the
* action throws an exception. Actions are performed in the order of iteration (if an iteration order is specified).
* Exceptions thrown by the action are relayed to the
*
* @param action The action to be performed for each {@link Binding}.
*/
public void forEach(Consumer action) {
this.bindings.forEach((marker, binding) -> action.accept(binding));
}
/*
* (non-Javadoc)
* @see java.lang.Iterable#iterator()
*/
@Override
public Iterator iterator() {
return this.bindings.values().iterator();
}
/*
* (non-Javadoc)
* @see java.lang.Iterable#spliterator()
*/
@Override
public Spliterator spliterator() {
return this.bindings.values().spliterator();
}
/**
* Base class for value objects representing a value or a {@code NULL} binding.
*/
public abstract static class Binding {
private final BindMarker marker;
protected Binding(BindMarker marker) {
this.marker = marker;
}
/**
* @return the associated {@link BindMarker}.
*/
public BindMarker getBindMarker() {
return this.marker;
}
/**
* Return {@literal true} if there is a value present, otherwise {@literal false} for a {@code NULL} binding.
*
* @return {@literal true} if there is a value present, otherwise {@literal false} for a {@code NULL} binding.
*/
public abstract boolean hasValue();
/**
* Return {@literal true} if this is is a {@code NULL} binding.
*
* @return {@literal true} if this is is a {@code NULL} binding.
*/
public boolean isNull() {
return !hasValue();
}
/**
* Returns the value of this binding. Can be {@literal null} if this is a {@code NULL} binding.
*
* @return value of this binding. Can be {@literal null} if this is a {@code NULL} binding.
*/
@Nullable
public abstract Object getValue();
/**
* Applies the binding to a {@link BindTarget}.
*
* @param bindTarget the target to apply bindings to.
*/
public abstract void apply(BindTarget bindTarget);
}
/**
* Value binding.
*/
public static class ValueBinding extends Binding {
private final Object value;
public ValueBinding(BindMarker marker, Object value) {
super(marker);
this.value = value;
}
/*
* (non-Javadoc)
* @see org.springframework.data.r2dbc.function.query.Bindings.Binding#hasValue()
*/
public boolean hasValue() {
return true;
}
/*
* (non-Javadoc)
* @see org.springframework.data.r2dbc.function.query.Bindings.Binding#getValue()
*/
public Object getValue() {
return this.value;
}
/*
* (non-Javadoc)
* @see org.springframework.data.r2dbc.function.query.Bindings.Binding#apply(io.r2dbc.spi.Statement)
*/
@Override
public void apply(BindTarget bindTarget) {
getBindMarker().bind(bindTarget, getValue());
}
}
/**
* {@code NULL} binding.
*/
public static class NullBinding extends Binding {
private final Class valueType;
public NullBinding(BindMarker marker, Class valueType) {
super(marker);
this.valueType = valueType;
}
/*
* (non-Javadoc)
* @see org.springframework.data.r2dbc.function.query.Bindings.Binding#hasValue()
*/
public boolean hasValue() {
return false;
}
/*
* (non-Javadoc)
* @see org.springframework.data.r2dbc.function.query.Bindings.Binding#getValue()
*/
@Nullable
public Object getValue() {
return null;
}
public Class getValueType() {
return this.valueType;
}
/*
* (non-Javadoc)
* @see org.springframework.data.r2dbc.function.query.Bindings.Binding#apply(BindTarget)
*/
@Override
public void apply(BindTarget bindTarget) {
getBindMarker().bindNull(bindTarget, getValueType());
}
}
}