All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.blazebit.persistence.impl.ParameterManager Maven / Gradle / Ivy

/*
 * Copyright 2014 - 2020 Blazebit.
 *
 * 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
 *
 *      http://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 com.blazebit.persistence.impl;

import com.blazebit.persistence.parser.expression.Expression;
import com.blazebit.persistence.parser.expression.ParameterExpression;
import com.blazebit.persistence.spi.AttributeAccessor;

import javax.persistence.Parameter;
import javax.persistence.Query;
import javax.persistence.TemporalType;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.HashSet;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;

/**
 *
 * @author Christian Beikov
 * @author Moritz Becker
 * @since 1.0.0
 */
public class ParameterManager {

    private static final String PREFIX = "param_";
    private int counter;
    private final Map> parameters = new TreeMap<>();
    private final Map valuesParameters = new TreeMap<>();
    private final ParameterRegistrationVisitor parameterRegistrationVisitor;
    private final ParameterUnregistrationVisitor parameterUnregistrationVisitor;
    private int positionalOffset = -1; // Records the last positional parameter index that was used

    public ParameterManager() {
        this.parameterRegistrationVisitor = new ParameterRegistrationVisitor(this);
        this.parameterUnregistrationVisitor = new ParameterUnregistrationVisitor(this);
    }

    public ParameterRegistrationVisitor getParameterRegistrationVisitor() {
        return parameterRegistrationVisitor;
    }

    public void collectParameterRegistrations(AbstractCommonQueryBuilder queryBuilder, ClauseType clauseType) {
        AbstractCommonQueryBuilder oldQueryBuilder = parameterRegistrationVisitor.getQueryBuilder();
        ClauseType oldClauseType = parameterRegistrationVisitor.getClauseType();
        try {
            parameterRegistrationVisitor.setClauseType(clauseType);
            parameterRegistrationVisitor.setQueryBuilder(queryBuilder);
            queryBuilder.applyVisitor(parameterRegistrationVisitor);
        } finally {
            parameterRegistrationVisitor.setClauseType(oldClauseType);
            parameterRegistrationVisitor.setQueryBuilder(oldQueryBuilder);
        }
    }

    public void collectParameterRegistrations(Expression expression, ClauseType clauseType, AbstractCommonQueryBuilder queryBuilder) {
        AbstractCommonQueryBuilder oldQueryBuilder = parameterRegistrationVisitor.getQueryBuilder();
        ClauseType oldClauseType = parameterRegistrationVisitor.getClauseType();
        try {
            parameterRegistrationVisitor.setClauseType(clauseType);
            parameterRegistrationVisitor.setQueryBuilder(queryBuilder);
            expression.accept(parameterRegistrationVisitor);
        } finally {
            parameterRegistrationVisitor.setClauseType(oldClauseType);
            parameterRegistrationVisitor.setQueryBuilder(oldQueryBuilder);
        }
    }

    public void collectParameterUnregistrations(Expression expression, ClauseType clauseType, AbstractCommonQueryBuilder queryBuilder) {
        AbstractCommonQueryBuilder oldQueryBuilder = parameterUnregistrationVisitor.getQueryBuilder();
        ClauseType oldClauseType = parameterUnregistrationVisitor.getClauseType();
        try {
            parameterUnregistrationVisitor.setClauseType(clauseType);
            parameterUnregistrationVisitor.setQueryBuilder(queryBuilder);
            expression.accept(parameterUnregistrationVisitor);
        } finally {
            parameterUnregistrationVisitor.setClauseType(oldClauseType);
            parameterUnregistrationVisitor.setQueryBuilder(oldQueryBuilder);
        }
    }

    Map copyFrom(ParameterManager parameterManager) {
        Map parameterMapping = new HashMap<>(parameterManager.parameters.size());
        for (Map.Entry> entry : parameterManager.parameters.entrySet()) {
            ParameterImpl param = (ParameterImpl) entry.getValue();
            Object paramValue = null;
            if (param.isValueSet()) {
                if (param.getParameterValue() == null) {
                    paramValue = param.getValue();
                } else {
                    paramValue = param.getParameterValue().copy();
                }
            }
            String oldParameterName = entry.getKey();
            String newParameterName;
            if (Character.isDigit(oldParameterName.charAt(0))) {
                this.positionalOffset++;
                newParameterName = Integer.toString(this.positionalOffset);
            } else if (param.isImplicit() && !(paramValue instanceof ValuesParameterWrapper)) {
                newParameterName = PREFIX + counter++;
            } else {
                ParameterImpl existingParameter = (ParameterImpl) parameters.get(oldParameterName);
                newParameterName = oldParameterName;
                if (existingParameter != null) {
                    if (existingParameter.getParameterType() != param.getParameterType()) {
                        throw new IllegalStateException("Can't apply parameters! Parameter '" + oldParameterName + "' with type '" + param.getParameterType() + "' is incompatible with existing type: " + existingParameter.getParameterType());
                    }
                    if (existingParameter.isCollectionValued() != param.isCollectionValued()) {
                        throw new IllegalStateException("Can't apply parameters! Parameter '" + oldParameterName + "' is collection valued in one query, but not the other!");
                    }
                    if (existingParameter.getTranformer() != param.getTranformer()) {
                        throw new IllegalStateException("Can't apply parameters! Parameter '" + oldParameterName + "' has a tranfsformer in one query, but not the other!");
                    }
                    if (param.isValueSet()) {
                        existingParameter.setValue(paramValue);
                    }
                    continue;
                }
            }

            parameterMapping.put(oldParameterName, newParameterName);
            addParameterMapping(newParameterName, paramValue, param.isImplicit());
        }

        for (Map.Entry entry : parameterManager.valuesParameters.entrySet()) {
            if (this.valuesParameters.put(entry.getKey(), entry.getValue()) != null) {
                throw new IllegalArgumentException("Can't copy value parameters because of a name clash for value parameter with name: " + entry.getKey());
            }
        }

        return parameterMapping;
    }

    Set getParameterListNames(Query q) {
        return getParameterListNames(q, null);
    }

    Set getParameterListNames(Query q, String skippedParameterPrefix) {
        Set parameterListNames = new HashSet();
        collectParameterListNames(q, parameterListNames, skippedParameterPrefix);
        return parameterListNames;
    }

    void collectParameterListNames(Query q, Set parameterListNames) {
        collectParameterListNames(q, parameterListNames, null);
    }

    void collectParameterListNames(Query q, Set parameterListNames, String skippedParameterPrefix) {
        for (Parameter p: q.getParameters()) {
            String name = p.getName();
            // In case of positional parameters, we convert the position to a string and look it up instead
            if (name == null) {
                name = p.getPosition().toString();
            } else if (skippedParameterPrefix != null && name.startsWith(skippedParameterPrefix)) {
                continue;
            }
            ParameterImpl parameter = getParameter(name);
            if (parameter != null && parameter.isCollectionValued()) {
                parameterListNames.add(name);
            }
        }
    }

    void parameterizeQuery(Query q) {
        parameterizeQuery(q, null);
    }

    void parameterizeQuery(Query q, String skippedParameterPrefix) {
        Set requestedValueParameters = new HashSet();
        for (Parameter p : q.getParameters()) {
            String parameterName = p.getName();
            // In case of positional parameters, we convert the position to a string and look it up instead
            if (parameterName == null) {
                parameterName = p.getPosition().toString();
            } else if (skippedParameterPrefix != null && parameterName.startsWith(skippedParameterPrefix)) {
                continue;
            }
            ParameterImpl parameter = parameters.get(parameterName);
            if (parameter == null) {
                String valuesParameter = valuesParameters.get(parameterName);
                if (valuesParameter == null) {
                    throw new IllegalArgumentException(String.format("Parameter name \"%s\" does not exist", parameterName));
                }

                // Skip binding the sub-parameter, we will do that in one go at the end
                requestedValueParameters.add(valuesParameter);
                continue;
            }

            // If a query requests the values parameter directly, it is aware of handling it
            if (parameter.getParameterValue() instanceof ValuesParameterWrapper) {
                if (parameter.getValue() != null) {
                    q.setParameter(parameterName, parameter.getValue());
                }
            } else {
                parameter.bind(q);
            }
        }

        for (String parameterName : requestedValueParameters) {
            ParameterImpl parameter = parameters.get(parameterName);
            parameter.bind(q);
        }
    }

    @SuppressWarnings({ "unchecked", "rawtypes" })
    public ParameterImpl getParameter(String parameterName) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        return parameter;
    }

    @SuppressWarnings({ "unchecked", "rawtypes" })
    public Set> getParameters() {
        return new HashSet>(parameters.values());
    }

    public Map getValuesParameters() {
        return Collections.unmodifiableMap(valuesParameters);
    }

    public Map getTransformers() {
        Map transformers = new HashMap<>();
        for (Map.Entry> entry : parameters.entrySet()) {
            ParameterValueTransformer transformer = entry.getValue().getTranformer();
            if (transformer != null) {
                transformers.put(entry.getKey(), transformer);
            }
        }
        return transformers;
    }

    public Map getValuesBinders() {
        Map binders = new HashMap<>();
        for (Map.Entry> entry : parameters.entrySet()) {
            ParameterValue value = entry.getValue().getParameterValue();
            if (value instanceof ValuesParameterWrapper) {
                binders.put(entry.getKey(), ((ValuesParameterWrapper) value).getBinder());
            }
        }
        return binders;
    }

    public boolean containsParameter(String parameterName) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        return parameters.containsKey(parameterName);
    }

    public boolean isParameterSet(String parameterName) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        return parameter != null && parameter.getValue() != null;
    }

    public Object getParameterValue(String parameterName) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        if (parameter == null) {
            throw new IllegalArgumentException(String.format("Parameter name \"%s\" does not exist", parameterName));
        }
        return parameter.getValue();
    }

    public ParameterExpression addParameterExpression(Object o, ClauseType clause, AbstractCommonQueryBuilder queryBuilder) {
        String name = addParameter(o, o instanceof Collection, clause, queryBuilder);
        return new ParameterExpression(name, o, o instanceof Collection);
    }

    private String addParameter(Object o, boolean collectionValued, ClauseType clause, AbstractCommonQueryBuilder queryBuilder) {
        if (o == null) {
            throw new NullPointerException();
        }
        String name = PREFIX + counter++;
        parameters.put(name, new ParameterImpl<>(name, collectionValued, clause, queryBuilder, o));
        return name;
    }

    public void addParameterMapping(String parameterName, Object o, boolean implicit) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        Integer position = determinePositionalOffset(parameterName);
        if (position == null) {
            parameters.put(parameterName, new ParameterImpl<>(parameterName, o instanceof Collection, implicit, o));
        } else {
            parameters.put(parameterName, new ParameterImpl<>(position, o instanceof Collection, implicit, o));
        }
    }

    public void addParameterMapping(String parameterName, Object o, ClauseType clause, AbstractCommonQueryBuilder queryBuilder) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        Integer position = determinePositionalOffset(parameterName);
        if (position == null) {
            parameters.put(parameterName, new ParameterImpl<>(parameterName, o instanceof Collection, clause, queryBuilder, o));
        } else {
            parameters.put(parameterName, new ParameterImpl<>(position, o instanceof Collection, clause, queryBuilder, o));
        }
    }

    public void registerParameterName(String parameterName, boolean collectionValued, ClauseType clause, AbstractCommonQueryBuilder queryBuilder) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        if (parameter == null) {
            Integer position = determinePositionalOffset(parameterName);
            if (position == null) {
                parameters.put(parameterName, new ParameterImpl<>(parameterName, collectionValued, false, clause, queryBuilder));
            } else {
                parameters.put(parameterName, new ParameterImpl<>(position, collectionValued, false, clause, queryBuilder));
            }
        } else {
            Set> builders = parameter.getClauseTypes().get(clause);
            if (builders == null) {
                builders = Collections.newSetFromMap(new IdentityHashMap, Boolean>());
                parameter.getClauseTypes().put(clause, builders);
            }
            builders.add(queryBuilder);
        }
    }

    private Integer determinePositionalOffset(String parameterName) {
        if (Character.isDigit(parameterName.charAt(0))) {
            int value = Integer.parseInt(parameterName);
            positionalOffset = Math.max(value, positionalOffset);
            return value;
        }
        return null;
    }

    public void unregisterParameterName(String parameterName, ClauseType clauseType, AbstractCommonQueryBuilder queryBuilder) {
        ParameterImpl parameter = parameters.get(parameterName);
        if (parameter != null) {
            Set> builders = parameter.getClauseTypes().get(clauseType);
            if (builders != null) {
                builders.remove(queryBuilder);
                if (builders.isEmpty()) {
                    parameter.getClauseTypes().remove(clauseType);
                    if (parameter.getClauseTypes().isEmpty()) {
                        parameters.remove(parameterName);
                    }
                }
            }
        }
    }

    public void registerValuesParameter(String parameterName, Class type, String[][] parameterNames, AttributeAccessor[] pathExpressions, AbstractCommonQueryBuilder queryBuilder) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        if (parameters.containsKey(parameterName)) {
            throw new IllegalArgumentException("Can't register parameter for VALUES clause because there already exists a parameter with the name: " + parameterName);
        }
        parameters.put(parameterName, new ParameterImpl(parameterName, false, ClauseType.JOIN, queryBuilder, new ValuesParameterWrapper(type, parameterNames, pathExpressions)));
        for (int i = 0; i < parameterNames.length; i++) {
            for (int j = 0; j < parameterNames[i].length; j++) {
                valuesParameters.put(parameterNames[i][j], parameterName);
            }
        }
    }

    @SuppressWarnings({ "rawtypes", "unchecked" })
    public void satisfyParameter(String parameterName, Object parameterValue) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        if (parameter == null) {
            throw new IllegalArgumentException(String.format("Parameter name \"%s\" does not exist", parameterName));
        }
        parameter.setValue(parameterValue);
    }

    @SuppressWarnings({ "rawtypes", "unchecked" })
    public void satisfyParameter(String parameterName, Calendar value, TemporalType temporalType) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        if (parameter == null) {
            throw new IllegalArgumentException(String.format("Parameter name \"%s\" does not exist", parameterName));
        }
        parameter.setValue(new TemporalCalendarParameterWrapper(temporalType, value));
    }

    @SuppressWarnings({ "rawtypes", "unchecked" })
    public void satisfyParameter(String parameterName, Date value, TemporalType temporalType) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        if (parameter == null) {
            throw new IllegalArgumentException(String.format("Parameter name \"%s\" does not exist", parameterName));
        }
        parameter.setValue(new TemporalDateParameterWrapper(temporalType, value));
    }

    @SuppressWarnings({ "unchecked" })
    public void setParameterType(String parameterName, Class type) {
        if (parameterName == null) {
            throw new NullPointerException("parameterName");
        }
        ParameterImpl parameter = parameters.get(parameterName);
        if (parameter == null) {
            throw new IllegalArgumentException(String.format("Parameter name \"%s\" does not exist", parameterName));
        }
        // TODO: maybe we should do some checks here?
        parameter.setParameterType((Class) type);
    }

    public int getPositionalOffset() {
        if (positionalOffset == -1) {
            return -1;
        }
        return positionalOffset + 1;
    }

    // TODO: needs equals-hashCode implementation

    /**
     * @author Christian Beikov
     * @since 1.2.0
     */
    static final class ParameterImpl implements ExtendedParameter {

        private final String name;
        private final Integer position;
        private final boolean collectionValued;
        private final boolean implicit;
        private final Map>> clauseTypes;
        private Class parameterType;
        private T value;
        private boolean valueSet;
        private ParameterValueTransformer tranformer;

        public ParameterImpl(String name, boolean collectionValued, boolean implicit, ClauseType clause, AbstractCommonQueryBuilder queryBuilder) {
            this.name = name;
            this.position = null;
            this.collectionValued = collectionValued;
            this.implicit = implicit;
            this.clauseTypes = new EnumMap<>(ClauseType.class);
            if (clause != null) {
                Set> builders = Collections.newSetFromMap(new IdentityHashMap, Boolean>());
                builders.add(queryBuilder);
                this.clauseTypes.put(clause, builders);
            }
        }

        public ParameterImpl(String name, boolean collectionValued, boolean implicit, T value) {
            this(name, collectionValued, implicit, null, null);
            setValue(value);
        }

        public ParameterImpl(String name, boolean collectionValued, ClauseType clause, AbstractCommonQueryBuilder queryBuilder, T value) {
            this(name, collectionValued, true, clause, queryBuilder);
            setValue(value);
        }

        public ParameterImpl(int position, boolean collectionValued, boolean implicit, ClauseType clause, AbstractCommonQueryBuilder queryBuilder) {
            this.name = null;
            this.position = position;
            this.collectionValued = collectionValued;
            this.implicit = implicit;
            this.clauseTypes = new EnumMap<>(ClauseType.class);
            if (clause != null) {
                Set> builders = Collections.newSetFromMap(new IdentityHashMap, Boolean>());
                builders.add(queryBuilder);
                this.clauseTypes.put(clause, builders);
            }
        }

        public ParameterImpl(int position, boolean collectionValued, boolean implicit, T value) {
            this(position, collectionValued, implicit, null, null);
            setValue(value);
        }

        public ParameterImpl(int position, boolean collectionValued, ClauseType clause, AbstractCommonQueryBuilder queryBuilder, T value) {
            this(position, collectionValued, true, clause, queryBuilder);
            setValue(value);
        }

        @Override
        public String getName() {
            return name;
        }

        @Override
        public Integer getPosition() {
            return position;
        }

        @Override
        public boolean isCollectionValued() {
            return collectionValued;
        }

        public Map>> getClauseTypes() {
            return clauseTypes;
        }

        @Override
        public Class getParameterType() {
            return parameterType;
        }

        public void setParameterType(Class parameterType) {
            this.parameterType = parameterType;
        }

        public ParameterValue getParameterValue() {
            if (value instanceof ParameterValue) {
                return (ParameterValue) value;
            }
            return null;
        }

        public boolean isImplicit() {
            return implicit;
        }

        public boolean isValueSet() {
            return valueSet;
        }

        @SuppressWarnings("unchecked")
        public T getValue() {
            if (value instanceof ParameterValue) {
                return (T) ((ParameterValue) value).getValue();
            }

            return value;
        }

        @SuppressWarnings({ "unchecked" })
        public void setValue(T value) {
            this.valueSet = true;
            if (tranformer != null) {
                value = transform(value);
            }
            if (this.value instanceof ParameterValue) {
                this.value = (T) ((ParameterValue) this.value).withValue(value);
            } else {
                this.value = value;
                if (value != null) {
                    if (value instanceof ParameterValue) {
                        parameterType = (Class) ((ParameterValue) value).getValueType();
                    } else {
                        parameterType = (Class) value.getClass();
                    }
                }
            }
        }

        @SuppressWarnings("unchecked")
        private T transform(T value) {
            if (value instanceof Collection) {
                Collection values = (Collection) value;
                List list = new ArrayList<>(values.size());
                for (Object o : values) {
                    list.add(tranformer.transform(o));
                }
                return (T) list;
            } else {
                return (T) tranformer.transform(value);
            }
        }

        public ParameterValueTransformer getTranformer() {
            return tranformer;
        }

        public void setTranformer(ParameterValueTransformer tranformer) {
            if (this.tranformer == null) {
                this.tranformer = tranformer;
                if (valueSet) {
                    this.value = transform(value);
                }
            } else if (!this.tranformer.equals(tranformer)) {
                throw new IllegalStateException("Tried to set parameter value transformer [" + tranformer + "] although a transformer [" + this.tranformer + "] is already set for parameter: " + name);
            }
        }

        public void bind(Query q) {
            if (valueSet) {
                if (value instanceof ParameterValue) {
                    if (name == null) {
                        ((ParameterValue) value).bind(q, position);
                    } else {
                        ((ParameterValue) value).bind(q, name);
                    }
                } else {
                    if (name == null) {
                        q.setParameter(position, value);
                    } else {
                        q.setParameter(name, value);
                    }
                }
            }
        }

        @Override
        public boolean equals(Object o) {
            if (this == o) {
                return true;
            }
            if (!(o instanceof Parameter)) {
                return false;
            }

            Parameter parameter = (Parameter) o;

            if (name != null ? !name.equals(parameter.getName()) : parameter.getName() != null) {
                return false;
            }
            return position != null ? position.equals(parameter.getPosition()) : parameter.getPosition() == null;
        }

        @Override
        public int hashCode() {
            int result = name != null ? name.hashCode() : 0;
            result = 31 * result + (position != null ? position.hashCode() : 0);
            return result;
        }
    }

    /**
     * @author Christian Beikov
     * @since 1.2.0
     */
    static interface ParameterValue {

        public ParameterValue copy();

        public Class getValueType();

        public Object getValue();

        public ParameterValue withValue(Object value);

        public void bind(Query query, String name);

        public void bind(Query query, int position);

    }

    /**
     * @author Christian Beikov
     * @since 1.2.0
     */
    static final class TemporalCalendarParameterWrapper implements ParameterValue {

        private final TemporalType type;
        private Calendar value;

        public TemporalCalendarParameterWrapper(TemporalType type, Calendar value) {
            this.type = type;
            this.value = value;
        }

        @Override
        public ParameterValue copy() {
            Calendar newValue = null;
            if (value != null) {
                newValue = (Calendar) value.clone();
            }
            return new TemporalCalendarParameterWrapper(type, newValue);
        }

        @Override
        public Calendar getValue() {
            return value;
        }

        @Override
        public ParameterValue withValue(Object value) {
            this.value = (Calendar) value;
            return this;
        }

        @Override
        public Class getValueType() {
            return Calendar.class;
        }

        @Override
        public void bind(Query query, String name) {
            query.setParameter(name, value, type);
        }

        @Override
        public void bind(Query query, int position) {
            query.setParameter(position, value, type);
        }
    }

    /**
     * @author Christian Beikov
     * @since 1.2.0
     */
    static final class TemporalDateParameterWrapper implements ParameterValue {

        private final TemporalType type;
        private Date value;

        public TemporalDateParameterWrapper(TemporalType type, Date value) {
            this.type = type;
            this.value = value;
        }

        @Override
        public ParameterValue copy() {
            Date newValue = null;
            if (value != null) {
                newValue = (Date) value.clone();
            }
            return new TemporalDateParameterWrapper(type, newValue);
        }

        @Override
        public Date getValue() {
            return value;
        }

        @Override
        public ParameterValue withValue(Object value) {
            this.value = (Date) value;
            return this;
        }

        @Override
        public Class getValueType() {
            return Date.class;
        }

        @Override
        public void bind(Query query, String name) {
            query.setParameter(name, value, type);
        }

        @Override
        public void bind(Query query, int position) {
            query.setParameter(position, value, type);
        }
    }

    /**
     * @author Christian Beikov
     * @since 1.2.0
     */
    static final class ValuesParameterWrapper implements ParameterValue {

        private final Class type;
        private final ValuesParameterBinder binder;
        private Collection value;

        public ValuesParameterWrapper(Class type, String[][] parameterNames, AttributeAccessor[] pathExpressions) {
            this.type = type;
            this.binder = new ValuesParameterBinder(parameterNames, pathExpressions);
        }

        private ValuesParameterWrapper(Class type, ValuesParameterBinder binder) {
            this.type = type;
            this.binder = binder;
        }

        @Override
        public ParameterValue copy() {
            Collection newValue = null;
            if (value != null) {
                newValue = new ArrayList(value);
            }
            return new ValuesParameterWrapper(type, binder).withValue(newValue);
        }

        public ValuesParameterBinder getBinder() {
            return binder;
        }

        @Override
        public Object getValue() {
            return value;
        }

        @Override
        public Class getValueType() {
            return Collection.class;
        }

        @Override
        public ParameterValue withValue(Object value) {
            if (value == null) {
                throw new IllegalArgumentException("null not allowed for VALUES parameter!");
            }
            if (!(value instanceof Collection)) {
                throw new IllegalArgumentException("Value for VALUES parameter must be a collection! Unsupported type: " + value.getClass());
            }

            @SuppressWarnings("unchecked")
            Collection collection = (Collection) value;
            if (collection.size() > binder.size()) {
                throw new IllegalArgumentException("The size of the collection must be lower or equal to the specified size for the VALUES clause.");
            }
            // NOTE: be careful when changing this, there might be code that depends on this not being copied for performance
            this.value = collection;
            return this;
        }

        @Override
        public void bind(Query query, String name) {
            if (value == null) {
                throw new IllegalArgumentException("No values are bound for parameter with name: " + name);
            }

            binder.bind(query, value);
        }

        @Override
        public void bind(Query query, int position) {
            if (value == null) {
                throw new IllegalArgumentException("No values are bound for parameter with position: " + position);
            }

            binder.bind(query, value);
        }
    }
}