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

Class ASTLiteral

  • All Implemented Interfaces:
    net.sourceforge.pmd.lang.ast.Node, JavaNode, TypeNode, net.sourceforge.pmd.lang.symboltable.ScopedNode
    public class ASTLiteral
extends AbstractJavaTypeNode

    • Field Summary

      • Fields inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

        beginColumn, beginLine, childIndex, children, endColumn, endLine, firstToken, id, lastToken, parent

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      String getEscapedStringLiteral()
      Tries to reconstruct the original string literal.
      String getTextBlockContent()
      Returns the content of the text block after normalizing line endings to LF, removing incidental white space surrounding the text block and interpreting escape sequences.
      double getValueAsDouble()  
      float getValueAsFloat()  
      int getValueAsInt()  
      long getValueAsLong()  
      boolean isCharLiteral()  
      boolean isDoubleLiteral()
      Checks whether this literal describes a double.
      boolean isFloatLiteral()  
      boolean isIntLiteral()  
      boolean isLongLiteral()
      Checks whether this literal is a long integer.
      boolean isSingleCharacterStringLiteral()
      Returns true if this is a String literal with only one character.
      boolean isStringLiteral()  
      boolean isTextBlock()  
      Object jjtAccept​(JavaParserVisitor visitor, Object data)
      Calls back the visitor's visit method corresponding to the runtime type of this Node.
      void setCharLiteral()
      Deprecated.
      void setFloatLiteral()
      Deprecated.
      void setIntLiteral()
      Deprecated.
      void setStringLiteral()
      Deprecated.

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

        children, getChild, getParent

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

        appendElement, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, hasDecendantOfAnyType, hasDescendantMatchingXPath, hasDescendantOfAnyType, hasDescendantOfType, hasImageEqualTo, isFindBoundary, isSingleLine, jjtAddChild, jjtGetChild, jjtGetChildIndex, jjtGetFirstToken, jjtGetId, jjtGetLastToken, jjtGetNumChildren, jjtGetParent, jjtSetChildIndex, jjtSetFirstToken, jjtSetLastToken, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData, testingOnlySetBeginColumn, testingOnlySetBeginLine, testingOnlySetEndColumn, testingOnlySetEndLine, toString

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

        findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasDescendantMatchingXPath, hasDescendantOfType, hasImageEqualTo, isFindBoundary, jjtAddChild, jjtClose, jjtGetChild, jjtGetChildIndex, jjtGetId, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetChildIndex, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData

      • Methods inherited from interface net.sourceforge.pmd.lang.symboltable.ScopedNode

        getScope

    • Constructor Detail

      • ASTLiteral

        @InternalApi
@Deprecated
public ASTLiteral​(int id)
        Deprecated.

    • Method Detail

      • setIntLiteral

        @InternalApi
@Deprecated
public void setIntLiteral()
        Deprecated.

      • isIntLiteral

        public boolean isIntLiteral()

      • isLongLiteral

        public boolean isLongLiteral()
        Checks whether this literal is a long integer.
        Returns:
        true if this literal is a long

      • setFloatLiteral

        @InternalApi
@Deprecated
public void setFloatLiteral()
        Deprecated.

      • isFloatLiteral

        public boolean isFloatLiteral()

      • isDoubleLiteral

        public boolean isDoubleLiteral()
        Checks whether this literal describes a double.
        Returns:
        true if this literal is a double.

      • getValueAsInt

        public int getValueAsInt()

      • getValueAsLong

        public long getValueAsLong()

      • getValueAsFloat

        public float getValueAsFloat()

      • getValueAsDouble

        public double getValueAsDouble()

      • setCharLiteral

        @InternalApi
@Deprecated
public void setCharLiteral()
        Deprecated.

      • isCharLiteral

        public boolean isCharLiteral()

      • setStringLiteral

        @InternalApi
@Deprecated
public void setStringLiteral()
        Deprecated.

      • isStringLiteral

        public boolean isStringLiteral()

      • getEscapedStringLiteral

        public String getEscapedStringLiteral()
        Tries to reconstruct the original string literal. If the original length is greater than the parsed String literal, then probably some unicode escape sequences have been used.
        Returns:

      • isSingleCharacterStringLiteral

        public boolean isSingleCharacterStringLiteral()
        Returns true if this is a String literal with only one character. Handles octal and escape characters.
        Returns:
        true is this is a String literal with only one character

      • isTextBlock

        public boolean isTextBlock()

      • getTextBlockContent

        @Experimental
public String getTextBlockContent()
        Returns the content of the text block after normalizing line endings to LF, removing incidental white space surrounding the text block and interpreting escape sequences.

        Note: This is a Java 14 Preview Feature.