org.eclipse.jdt.core.dom
Class StringLiteral

java.lang.Object
  |
  +--org.eclipse.jdt.core.dom.ASTNode
        |
        +--org.eclipse.jdt.core.dom.Expression
              |
              +--org.eclipse.jdt.core.dom.StringLiteral

public class StringLiteral

extends Expression

String literal nodes.

Since:

2.0

Field Summary

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, MALFORMED, METHOD_DECLARATION, METHOD_INVOCATION, NULL_LITERAL, NUMBER_LITERAL, PACKAGE_DECLARATION, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, QUALIFIED_NAME, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT

Method Summary

String	getEscapedValue() Returns the string value of this literal node to the given string literal token.
String	getLiteralValue() Returns the value of this literal node.
int	getNodeType() Returns an integer value identifying the type of this concrete AST node.
void	setEscapedValue(String token) Sets the string value of this literal node to the given string literal token.
void	setLiteralValue(String value) Sets the value of this literal node.
boolean	subtreeMatch(ASTMatcher matcher, Object other) Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.

Methods inherited from class org.eclipse.jdt.core.dom.Expression

resolveTypeBinding

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, equals, getAST, getFlags, getLength, getParent, getProperty, getRoot, getStartPosition, properties, setFlags, setProperty, setSourceRange, subtreeBytes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getNodeType

public int getNodeType()

Description copied from class: ASTNode

Returns an integer value identifying the type of this concrete AST node. The values are small positive integers, suitable for use in switch statements.

For each concrete node type there is a unique node type constant (name and value). The unique node type constant for a concrete node type such as CastExpression is ASTNode.CAST_EXPRESSION.

Specified by:

getNodeType in class ASTNode

Returns:

one of the node type constants

subtreeMatch

public boolean subtreeMatch(ASTMatcher matcher,
                            Object other)

Description copied from class: ASTNode

Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.

Specified by:

subtreeMatch in class ASTNode

Parameters:

matcher - the matcher

other - the other object, or null

Returns:

true if the subtree matches, or false if they do not match

getEscapedValue

public String getEscapedValue()

Returns the string value of this literal node to the given string literal token. The token is the sequence of characters that would appear in the source program, including enclosing double quotes and embedded escapes.

Returns:

the string literal token, including enclosing double quotes and embedded escapes

setEscapedValue

public void setEscapedValue(String token)

Sets the string value of this literal node to the given string literal token. The token is the sequence of characters that would appear in the source program, including enclosing double quotes and embedded escapes. For example,

• "" setLiteral("\"\"")
• "hello world" setLiteral("\"hello world\"")
• "boo\nhoo" setLiteral("\"boo\\nhoo\"")

Parameters:

token - the string literal token, including enclosing double quotes and embedded escapes

Throws:

IllegalArgumentException - if the argument is incorrect

getLiteralValue

public String getLiteralValue()

Returns the value of this literal node.

For example,

 StringLiteral s;
 s.setEscapedValue("\"hello\\nworld\"");
 assert s.getLiteralValue().equals("hello\nworld");
 

Note that this is a convenience method that converts from the stored string literal token returned by getEscapedLiteral.

Returns:

the string value without enclosing double quotes and embedded escapes

Throws:

IllegalArgumentException - if the literal value cannot be converted

setLiteralValue

public void setLiteralValue(String value)

Sets the value of this literal node.

For example,

 StringLiteral s;
 s.setLiteralValue("hello\nworld");
 assert s.getEscapedValue("\"hello\\nworld\"");
 assert s.getLiteralValue().equals("hello\nworld");
 

Note that this is a convenience method that converts to the stored string literal token acceptable to setEscapedLiteral.

Throws:

IllegalArgumentException - if the argument is incorrect