Package org.eclipse.jdt.core.dom

Class StringTemplateExpression

java.lang.Object

org.eclipse.jdt.core.dom.ASTNode

org.eclipse.jdt.core.dom.Expression

org.eclipse.jdt.core.dom.StringTemplateExpression

public class StringTemplateExpression
extends Expression

StringTemplateExpression AST node type.

 StringTemplateExpression:
    Expression . " StringFragment [StringTemplateComponent {StringTemplateComponent}] "
 

For a multi-line text block, corresponding delimiters are applicable instead of single quotes.

Since:

3.37

Restriction:

This class is not intended to be referenced by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChildPropertyDescriptor	FIRST_STRING_FRAGMENT	The "firstFragment" structural property of this node type (child type: StringFragment).
static final SimplePropertyDescriptor	MULTI_LINE	The "multiline" structural property of this node type (type: Boolean).
static final ChildListPropertyDescriptor	STRING_TEMPLATE_COMPONENTS	The "components" structural property of this node type (child type: StringTemplateComponent).
static final ChildPropertyDescriptor	TEMPLATE_PROCESSOR	The "processor" structural property of this node type (child type: Expression).

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

ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CASE_DEFAULT_EXPRESSION, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, CREATION_REFERENCE, DIMENSION, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENHANCED_FOR_WITH_RECORD_PATTERN, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPORTS_DIRECTIVE, EXPRESSION_METHOD_REFERENCE, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, GUARDED_PATTERN, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, INTERSECTION_TYPE, JAVADOC, JAVADOC_REGION, JAVADOC_TEXT_ELEMENT, LABELED_STATEMENT, LAMBDA_EXPRESSION, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, MODULE_DECLARATION, MODULE_MODIFIER, MODULE_QUALIFIED_NAME, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NULL_PATTERN, NUMBER_LITERAL, OPENS_DIRECTIVE, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, PATTERN_INSTANCEOF_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, PROVIDES_DIRECTIVE, QUALIFIED_NAME, QUALIFIED_TYPE, RECORD_DECLARATION, RECORD_PATTERN, RECOVERED, REQUIRES_DIRECTIVE, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_FRAGMENT, STRING_LITERAL, STRING_TEMPLATE_COMPONENT, STRING_TEMPLATE_EXPRESSION, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SUPER_METHOD_REFERENCE, SWITCH_CASE, SWITCH_EXPRESSION, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TAG_PROPERTY, TEXT_BLOCK, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, TYPE_PATTERN, UNION_TYPE, USES_DIRECTIVE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE, YIELD_STATEMENT

Method Summary

Modifier and Type	Method	Description
List<StringTemplateComponent>	components()
StringFragment	getFirstFragment()
Expression	getProcessor()	Returns the String template processor of this string template expression.
boolean	isMultiline()
static List	propertyDescriptors(int apiLevel)	Returns a list of structural property descriptors for this node type.
static List	propertyDescriptors(int apiLevel, boolean previewEnabled)
void	setFirstFragment(StringFragment firstFragment)
void	setIsMultiline(boolean isMultitine)
void	setProcessor(Expression processor)

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

resolveBoxing, resolveConstantExpressionValue, resolveTypeBinding, resolveUnboxing

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

accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang.Object

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

Field Details

TEMPLATE_PROCESSOR

public static final ChildPropertyDescriptor TEMPLATE_PROCESSOR

The "processor" structural property of this node type (child type: Expression).

Since:

3.37

FIRST_STRING_FRAGMENT

public static final ChildPropertyDescriptor FIRST_STRING_FRAGMENT

The "firstFragment" structural property of this node type (child type: StringFragment).

STRING_TEMPLATE_COMPONENTS

public static final ChildListPropertyDescriptor STRING_TEMPLATE_COMPONENTS

The "components" structural property of this node type (child type: StringTemplateComponent).

MULTI_LINE

public static final SimplePropertyDescriptor MULTI_LINE

The "multiline" structural property of this node type (type: Boolean).

Method Details

setProcessor

public void setProcessor(Expression processor)

Restriction:

This method is not intended to be referenced by clients as it is a part of Java preview feature.

getProcessor

public Expression getProcessor()

Returns the String template processor of this string template expression.

Restriction:

This method is not intended to be referenced by clients as it is a part of Java preview feature.

setFirstFragment

public void setFirstFragment(StringFragment firstFragment)

Restriction:

This method is not intended to be referenced by clients as it is a part of Java preview feature.

getFirstFragment

public StringFragment getFirstFragment()

Restriction:

This method is not intended to be referenced by clients as it is a part of Java preview feature.

components

public List<StringTemplateComponent> components()

Restriction:

This method is not intended to be referenced by clients as it is a part of Java preview feature.

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.24

propertyDescriptors

public static List propertyDescriptors(int apiLevel,
 boolean previewEnabled)

isMultiline

public boolean isMultiline()

setIsMultiline

public void setIsMultiline(boolean isMultitine)