org.eclipse.persistence.jpa.jpql.parser.StringLiteral Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation
EclipseLink build based upon Git transaction f2b9fc5
There is a newer version: 5.0.0-B03
/*
 * Copyright (c) 2006, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation
//
package org.eclipse.persistence.jpa.jpql.parser;

import java.util.List;
import org.eclipse.persistence.jpa.jpql.ExpressionTools;
import org.eclipse.persistence.jpa.jpql.WordParser;

/**
 * A string literal is enclosed in single quotes. For example: 'literal'. A string literal that
 * includes a single quote is represented by two single quotes. For example: 'literal''s'. String
 * literals in queries, like Java String literals, use unicode character encoding. Approximate
 * literals support the use Java floating point literal syntax as well as SQL approximate numeric
 * literal syntax. Enum literals support the use of Java enum literal syntax. The enum class name
 * must be specified. Appropriate suffixes may be used to indicate the specific type of a numeric
 * literal in accordance with the Java Language Specification. The boolean literals are TRUE
 * and FALSE. Although predefined reserved literals appear in upper case, they are case
 * insensitive.
 *
 * @version 2.4
 * @since 2.3
 * @author Pascal Filion
 */
public final class StringLiteral extends AbstractExpression {

    /**
     * Caches the value indicating if the string literal has the closing quote.
     */
    private Boolean hasCloseQuote;

    /**
     * Creates a new StringLiteral.
     *
     * @param parent The parent of this expression
     * @param literal The string literal
     */
    public StringLiteral(AbstractExpression parent, String literal) {
        super(parent, literal);
    }

    @Override
    public void accept(ExpressionVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    public void acceptChildren(ExpressionVisitor visitor) {
    }

    @Override
    protected void addOrderedChildrenTo(List children) {
        children.add(buildStringExpression(getText()));
    }

    @Override
    public JPQLQueryBNF getQueryBNF() {
        return getQueryBNF(StringLiteralBNF.ID);
    }

    @Override
    public String getText() {
        return super.getText();
    }

    /**
     * Returns the string literal without the single quotes.
     *
     * @return The unquoted text
     */
    public String getUnquotedText() {
        return ExpressionTools.unquote(getText());
    }

    /**
     * Determines whether the closing quote was present or not.
     *
     * @return true if the literal is ended by a single quote; false
     * otherwise
     */
    public boolean hasCloseQuote() {
        if (hasCloseQuote == null) {
            String text = getText();
            int length = text.length();
            hasCloseQuote = (length > 1) && ExpressionTools.isQuote(text.charAt(length - 1));
        }
        return hasCloseQuote;
    }

    @Override
    protected void parse(WordParser wordParser, boolean tolerant) {
        wordParser.moveForward(getText());
    }

    @Override
    public String toActualText() {
        return getText();
    }

    @Override
    public String toParsedText() {
        return getText();
    }

    @Override
    protected void toParsedText(StringBuilder writer, boolean actual) {
        writer.append(getText());
    }
}