org.springframework.integration.jpa.support.JpaParameter.java Source code

Introduction

Here is the source code for org.springframework.integration.jpa.support.JpaParameter.java

Source

/*
 * Copyright 2002-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.integration.jpa.support;

import org.springframework.expression.Expression;
import org.springframework.expression.ExpressionParser;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

/**
 * Abstraction of Jpa parameters allowing to provide static parameters
 * and SpEl Expression based parameters.
 *
 * @author Gunnar Hillert
 * @author Artem Bilan
 * @author Gary Russell
 * @since 2.2
 *
 */
public class JpaParameter {

    private static final ExpressionParser PARSER = new SpelExpressionParser();

    private String name;

    private Object value;

    private String expression;

    private Expression spelExpression;

    private Expression projectionExpression;

    /**
     * Default constructor.
     */
    public JpaParameter() {
        super();
    }

    /**
     * Instantiates a new Jpa Parameter.
     *
     * @param name Name of the JPA parameter, must not be null or empty
     * @param value If null, the expression property must be set
     * @param expression If null, the value property must be set
     */
    public JpaParameter(String name, @Nullable Object value, @Nullable String expression) {
        super();

        Assert.hasText(name, "'name' must not be empty.");

        this.name = name;
        this.value = value;
        setExpression(expression);
    }

    /**
     * Instantiates a new Jpa Parameter without a name. This is useful for specifying
     * positional Jpa parameters.
     *
     * @param value If null, the expression property must be set
     * @param expression If null, the value property must be set
     */
    public JpaParameter(@Nullable Object value, @Nullable String expression) {
        this.value = value;
        setExpression(expression);
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Nullable
    public Object getValue() {
        return this.value;
    }

    public void setValue(Object value) {
        this.value = value;
    }

    @Nullable
    public String getExpression() {
        return this.expression;
    }

    @Nullable
    public Expression getSpelExpression() {
        return this.spelExpression;
    }

    @Nullable
    public Expression getProjectionExpression() {
        return this.projectionExpression;
    }

    public final void setExpression(@Nullable String expression) {
        if (expression != null) {
            this.expression = expression;
            this.spelExpression = PARSER.parseExpression(expression);
            this.projectionExpression = PARSER.parseExpression("#root.![" + expression + "]");
        }
    }

    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("JpaParameter [name=").append(this.name).append(", value=").append(this.value)
                .append(", expression=").append(this.expression).append("]");
        return builder.toString();
    }

}