Class CharacterLiteral


  • public class CharacterLiteral
    extends Expression
    Character literal nodes.
    Since:
    2.0
    Restriction:
    This class is not intended to be instantiated by clients.
    • Field Detail

      • ESCAPED_VALUE_PROPERTY

        public static final SimplePropertyDescriptor ESCAPED_VALUE_PROPERTY
        The "escapedValue" structural property of this node type (type: String).
        Since:
        3.0
    • Method Detail

      • propertyDescriptors

        public static List propertyDescriptors​(int apiLevel)
        Returns a list of structural property descriptors for this node type. Clients must not modify the result.
        Parameters:
        apiLevel - the API level; one of the AST.JLS* constants
        Returns:
        a list of property descriptors (element type: StructuralPropertyDescriptor)
        Since:
        3.0
      • getEscapedValue

        public String getEscapedValue()
        Returns the string value of this literal node. The value is the sequence of characters that would appear in the source program, including enclosing single quotes and embedded escapes.
        Returns:
        the escaped string value, including enclosing single quotes and embedded escapes
      • setEscapedValue

        public void setEscapedValue​(String value)
        Sets the string value of this literal node. The value is the sequence of characters that would appear in the source program, including enclosing single quotes and embedded escapes. For example,
        • 'a' setEscapedValue("\'a\'")
        • '\n' setEscapedValue("\'\\n\'")
        Parameters:
        value - the string value, including enclosing single quotes and embedded escapes
        Throws:
        IllegalArgumentException - if the argument is incorrect
      • charValue

        public char charValue()
        Returns the value of this literal node.

        For example,

         CharacterLiteral s;
         s.setEscapedValue("\'x\'");
         assert s.charValue() == 'x';
         
        Returns:
        the character value without enclosing quotes and embedded escapes
        Throws:
        IllegalArgumentException - if the literal value cannot be converted
      • setCharValue

        public void setCharValue​(char value)
        Sets the value of this character literal node to the given character.

        For example,

         CharacterLiteral s;
         s.setCharValue('x');
         assert s.charValue() == 'x';
         assert s.getEscapedValue().equals("\'x\'");
         
        Parameters:
        value - the character value