A string template, that is, a string start, followed by any number of value expression and string mid pairs, followed by a value expression and a string end.

(The distinction between string starts, mids, and ends is a purely lexical one, and not covered in ceylon.ast.)

There must be at least one expression in a string template, and the number of string literals must be exactly the number of expressions plus one.


"Elapsed: `` tEnd - tStart ``ms"
"Hello, ``person.firstName`` ``person.lastName``. How nice to see you back in ``person.homeTown``."

no subtypes hierarchy

StringTemplate([StringLiteral+] literals, [Expression+] expressions)
  • literals

    The string literals of the string template, in order of appearance.

  • expressions

    The expressions in the string template, in order of appearance.

childrenshared actual [StringLiteral|Expression+] children

The child nodes of this node.

Refines Expression.children ultimately refines Node.children
expressionsshared [Expression+] expressions

The expressions in the string template, in order of appearance.

hashshared actual Integer hash

The hash value of the value, which allows the value to be an element of a hash-based set or key of a hash-based map. Implementations must respect the constraint that:

  • if x==y then x.hash==y.hash.

Therefore, a class which refines equals must also refine hash.

Because the Integer type is platform-dependent a compiler for a given platform is permitted to further manipulate the calculated hash for an object, and the resulting hash may differ between platforms.

Refines Object.hash
literalsshared [StringLiteral+] literals

The string literals of the string template, in order of appearance.

Inherited Attributes
Attributes inherited from: Expression
Attributes inherited from: Node
Attributes inherited from: Object
hash, string
copyshared StringTemplate copy([StringLiteral+] literals = ..., [Expression+] expressions = ...)
  • literals = this.literals
  • expressions = this.expressions
equalsshared actual Boolean equals(Object that)

Determine if two values are equal. Implementations should respect the constraints that:

  • if x===y then x==y (reflexivity),
  • if x==y then y==x (symmetry),
  • if x==y and y==z then x==z (transitivity).

Furthermore it is recommended that implementations ensure that if x==y then x and y have the same concrete class.

A class which explicitly refines equals() is said to support value equality, and the equality operator == is considered much more meaningful for such classes than for a class which simply inherits the default implementation of identity equality from Identifiable.

Refines Object.equals
transformshared actual Result transform<out Result>(Transformer<Result> transformer)

Transform this node with the given transformer by calling the appropriate transformX method on the transformer.

If you have a Node node that’s actually an LIdentifier instance, then the runtime will call LIdentifier.transform; therefore, this method is by nature narrowing. This means that if transformer is a NarrowingTransformer, calling node.transform(transformer) is equivalent to calling transformer.transformNode(node). On the other hand, if transformer is a WideningTransformer, then the two operations are very different.

visitshared actual void visit(Visitor visitor)

Visit this node with the given visitor. Calls the appropriate visitX method on the visitor.

Refines Node.visit
Inherited Methods
Methods inherited from: Node
Methods inherited from: Object