Class StringLiteral

  • All Implemented Interfaces:

    public final class StringLiteral
    extends AbstractExpression
    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.
    Pascal Filion
    • Constructor Detail

      • StringLiteral

        public StringLiteral​(AbstractExpression parent,
                             java.lang.String literal)
        Creates a new StringLiteral.
        parent - The parent of this expression
        literal - The string literal
    • Method Detail

      • getText

        public java.lang.String getText()
        Returns the encapsulated text of this AbstractExpression, which can be used in various ways, it can be a keyword, a literal, etc.
        getText in class AbstractExpression
        Either the JPQL identifier for this AbstractExpression, the literal it encapsulates or an empty string
      • getUnquotedText

        public java.lang.String getUnquotedText()
        Returns the string literal without the single quotes.
        The unquoted text
      • hasCloseQuote

        public boolean hasCloseQuote()
        Determines whether the closing quote was present or not.
        true if the literal is ended by a single quote; false otherwise
      • parse

        protected void parse​(WordParser wordParser,
                             boolean tolerant)
        Parses the query by starting at the current position, which is part of the given WordParser.
        Specified by:
        parse in class AbstractExpression
        wordParser - The text to parse based on the current position of the cursor
        tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
      • toActualText

        public java.lang.String toActualText()
        Generates a string representation of this Expression, which needs to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist.
        Specified by:
        toActualText in interface Expression
        toActualText in class AbstractExpression
        The string representation of this Expression
      • toParsedText

        protected void toParsedText​(java.lang.StringBuilder writer,
                                    boolean actual)
        Generates a string representation of this Expression, including its children, if it has any.
        Specified by:
        toParsedText in class AbstractExpression
        writer - The buffer used to append this Expression's string representation
        actual - Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers