Package net.sourceforge.pmd.lang.java.ast

Class ASTStringLiteral

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected JSymbolTable symbolTable  

      • Fields inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

        id

      • Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

        COORDS_COMPARATOR

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <P,​R>
      R      		 acceptVisitor​(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,​? extends R> visitor, P data)  
      protected <P,​R>
      R      		 acceptVisitor​(JavaVisitor<? super P,​? extends R> visitor, P data)  
      protected void addChild​(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)  
      protected @NonNull String buildConstValue()  
      protected void enlargeLeft​(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)  
      @NonNull String getConstValue()
      Returns the value without delimiters and unescaped.
      String getImage()  
      net.sourceforge.pmd.lang.document.Chars getLiteralText()
      Return the text of the literal in the source file.
      int getParenthesisDepth()
      Returns the number of parenthesis levels around this expression.
      @NonNull ASTCompilationUnit getRoot()  
      @NonNull JSymbolTable getSymbolTable()
      Returns the symbol table for the program point represented by this node.
      net.sourceforge.pmd.lang.document.Chars getText()  
      @NonNull JTypeMirror getTypeMirror()
      Returns the compile-time type of this node.
      @NonNull JTypeMirror getTypeMirror​(TypingContext context)  
      TypeSystem getTypeSystem()
      Returns the type system with which this node was created.
      String getXPathNodeName()  
      protected void insertChild​(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)  
      boolean isCompileTimeConstant()
      Returns true if this expression is a compile-time constant, and is inlined.
      boolean isEmpty()
      True if the constant value is empty.
      boolean isTextBlock()
      Returns true if this is a text block (currently Java 13 preview feature).
      void jjtClose()  
      int length()
      Length of the constant value in characters.
      protected void removeChildAtIndex​(int childIndex)  
      protected void setChild​(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)  
      protected void setFirstToken​(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)  
      protected void setImage​(String image)  
      protected void setLastToken​(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)  
      @NonNull String toPrintableString()
      Returns a string where non-printable characters have been escaped using Java-like escape codes (eg \n, \t, \u00a0).

      • Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

        compareLocation, fitTokensToChildren, getFirstToken, getLastToken, getTextRegion, jjtOpen, toString

      • Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode

        children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, remove, setParent

      • Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

        ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling

      • Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode

        getFirstToken, getLastToken, tokens

      • Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

        acceptVisitor, ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, getTextDocument, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasImageEqualTo, isFindBoundary

      • Methods inherited from interface net.sourceforge.pmd.lang.ast.TextAvailableNode

        getOriginalText, getText, getTextRegion

    • Method Detail

      • getImage

        public String getImage()
        Specified by:
        getImage in interface net.sourceforge.pmd.lang.ast.Node
        Overrides:
        getImage in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • getLiteralText

        public net.sourceforge.pmd.lang.document.Chars getLiteralText()
        Description copied from interface: ASTLiteral
        Return the text of the literal in the source file. Note that TextAvailableNode.getText() may include parentheses.
        Specified by:
        getLiteralText in interface ASTLiteral

      • isTextBlock

        public boolean isTextBlock()
        Returns true if this is a text block (currently Java 13 preview feature).

      • isEmpty

        public boolean isEmpty()
        True if the constant value is empty. Does not necessarily compute the constant value.

      • length

        public int length()
        Length of the constant value in characters.

      • toPrintableString

        @NoAttribute
public @NonNull String toPrintableString()
        Returns a string where non-printable characters have been escaped using Java-like escape codes (eg \n, \t, \u00a0).

      • acceptVisitor

        protected <P,​R> R acceptVisitor​(JavaVisitor<? super P,​? extends R> visitor,
                                      P data)

      • buildConstValue

        protected @NonNull String buildConstValue()

      • jjtClose

        public void jjtClose()

      • getText

        @NoAttribute
public final net.sourceforge.pmd.lang.document.Chars getText()

      • isCompileTimeConstant

        public boolean isCompileTimeConstant()
        Description copied from interface: ASTExpression
        Returns true if this expression is a compile-time constant, and is inlined.

      • getParenthesisDepth

        public int getParenthesisDepth()
        Description copied from interface: ASTExpression
        Returns the number of parenthesis levels around this expression. If this method returns 0, then no parentheses are present.

        E.g. the expression (a + b) is parsed as an AdditiveExpression whose parenthesisDepth is 1, and in ((a + b)) it's 2.

        This is to avoid the parentheses interfering with analysis. Parentheses already influence parsing by breaking the natural precedence of operators. It would mostly hide false positives to make a ParenthesizedExpr node, because it would make semantically equivalent nodes have a very different representation.

        On the other hand, when a rule explicitly cares about parentheses, then this attribute may be used to find out whether parentheses were mentioned, so no information is lost.

        Specified by:
        getParenthesisDepth in interface ASTExpression

      • getTypeMirror

        public @NonNull JTypeMirror getTypeMirror()
        Description copied from interface: TypeNode
        Returns the compile-time type of this node. For example, for a string literal, returns the type mirror for String, for a method call, returns the return type of the call, etc.

        This method ignores conversions applied to the value of the node because of its context. For example, in 1 + "", the numeric literal will have type int, but it is converted to String by the surrounding concatenation expression. Similarly, in Collections.singletonList(1), the ASTNumericLiteral node has type int, but the type of the method formal is Integer, and boxing is applied at runtime. Possibly, an API will be added to expose this information.

        Specified by:
        getTypeMirror in interface TypeNode
        Returns:
        The type mirror. Never returns null; if the type is unresolved, returns TypeSystem.UNKNOWN.

      • acceptVisitor

        public final <P,​R> R acceptVisitor​(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,​? extends R> visitor,
                                         P data)
        Specified by:
        acceptVisitor in interface net.sourceforge.pmd.lang.ast.Node

      • addChild

        protected void addChild​(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)
        Overrides:
        addChild in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • insertChild

        protected void insertChild​(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                           int index)
        Overrides:
        insertChild in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • removeChildAtIndex

        protected void removeChildAtIndex​(int childIndex)
        Overrides:
        removeChildAtIndex in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • setImage

        protected void setImage​(String image)
        Overrides:
        setImage in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • setFirstToken

        protected void setFirstToken​(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
        Overrides:
        setFirstToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • setLastToken

        protected void setLastToken​(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
        Overrides:
        setLastToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • enlargeLeft

        protected void enlargeLeft​(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)
        Overrides:
        enlargeLeft in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • setChild

        protected void setChild​(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)
        Overrides:
        setChild in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,​JavaNode>

      • getSymbolTable

        public @NonNull JSymbolTable getSymbolTable()
        Description copied from interface: JavaNode
        Returns the symbol table for the program point represented by this node.
        Specified by:
        getSymbolTable in interface JavaNode

      • getTypeSystem

        public TypeSystem getTypeSystem()
        Description copied from interface: JavaNode
        Returns the type system with which this node was created. This is the object responsible for representing types in the compilation unit.
        Specified by:
        getTypeSystem in interface JavaNode

      • getRoot

        public final @NonNull ASTCompilationUnit getRoot()
        Specified by:
        getRoot in interface JavaNode
        Specified by:
        getRoot in interface net.sourceforge.pmd.lang.ast.Node

      • getXPathNodeName

        public final String getXPathNodeName()
        Specified by:
        getXPathNodeName in interface net.sourceforge.pmd.lang.ast.Node