org.dellroad.stuff.jibx.SpringParseUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dellroad-stuff-jibx Show documentation
DellRoad Stuff contains classes related to JiBX.
The newest version!

/*
 * Copyright (C) 2022 Archie L. Cobbs. All rights reserved.
 */

package org.dellroad.stuff.jibx;

import org.jibx.runtime.JiBXParseException;
import org.springframework.expression.Expression;
import org.springframework.expression.ParseException;
import org.springframework.expression.ParserContext;
import org.springframework.expression.spel.standard.SpelExpressionParser;

/**
 * JiBX parsing utility methods for Spring expressions.
 */
public final class SpringParseUtil {

    private SpringParseUtil() {
    }

    /**
     * Deserialize a Spring {@link Expression}. Equivalent to:
     *  
     *  SpringParseUtil.deserializeExpression(string, null);
     *  
     *
     * @param string encoded Spring expression
     * @return decoded expression
     * @see #serializeExpression
     * @throws JiBXParseException if the parse fails
     */
    public static Expression deserializeExpression(String string) throws JiBXParseException {
        return SpringParseUtil.deserializeExpression(string, null);
    }

    /**
     * Deserialize a Spring {@link Expression} as a template expression. Equivalent to:
     *  
     *  SpringParseUtil.deserializeExpression(string, ParserContext.TEMPLATE_EXPRESSION);
     *  
     *
     * @param string expression string
     * @return decoded value
     * @throws JiBXParseException if the parse fails
     * @see #serializeExpression
     * @see #deserializeExpression(String, ParserContext)
     */
    public static Expression deserializeTemplateExpression(String string) throws JiBXParseException {
        return SpringParseUtil.deserializeExpression(string, ParserContext.TEMPLATE_EXPRESSION);
    }

    /**
     * Deserialize a Spring {@link Expression} using the supplied {@link ParserContext}.
     *
     * @param string XML encoding created by {@link #serializeExpression}
     * @param context parser context
     * @return decoded value
     * @throws JiBXParseException if the parse fails
     * @see #serializeExpression
     */
    public static Expression deserializeExpression(String string, ParserContext context) throws JiBXParseException {
        SpelExpressionParser parser = new SpelExpressionParser();
        try {
            return parser.parseExpression(string, context);
        } catch (ParseException e) {
            throw new JiBXParseException("invalid Spring EL expression", string, e);
        }
    }

    /**
     * Serialize a Spring {@link Expression}.
     *
     * 
     * Returns {@code expr.getExpressionString()}.
     *
     * @param expr Spring expression
     * @return encoded value
     * @see #deserializeExpression
     */
    public static String serializeExpression(Expression expr) {
        return expr.getExpressionString();
    }
}