A string literal consists of a series of characters and/or, if it’s not verbatim, escape sequences.

Note: in contrast to IntegerLiteral and FloatLiteral, the value of text isn’t verified, and there is no attribute to get the String value of the literal; getting that value requires unicode support (to parse '{CHARACTER NAME}') that isn’t available on all platforms.

no subtypes hierarchy

Initializer
StringLiteral(String text, Boolean isVerbatim = false)
Parameters:
  • text

    The text of the string literal (without quotes).

  • isVerbatim = false

    If the string literal is verbatim or not. Verbatim string literals are surrounded by three quotes instead of one, and do not contain escape sequences.

    Note: While the default value is false because that’s the least surprising choice, you should use true instead unless you really need escape sequences; this makes your code more robust, especially if the text is coming from an external source.

Attributes
hashSource Codeshared 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.

Refines Object.hash
isVerbatimSource Codeshared Boolean isVerbatim

If the string literal is verbatim or not. Verbatim string literals are surrounded by three quotes instead of one, and do not contain escape sequences.

Note: While the default value is false because that’s the least surprising choice, you should use true instead unless you really need escape sequences; this makes your code more robust, especially if the text is coming from an external source.

textSource Codeshared actual String text

The text of the string literal (without quotes).

Refines Literal.text
Inherited Attributes
Attributes inherited from: Expression
Attributes inherited from: ExpressionIsh
Attributes inherited from: Literal
Attributes inherited from: Node
Attributes inherited from: Object
Methods
copySource Codeshared StringLiteral copy(String text = ..., Boolean isVerbatim = ...)
Parameters:
  • text = this.text
  • isVerbatim = this.isVerbatim
equalsSource Codeshared actual Boolean equals(Object other)

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.

transformSource Codeshared 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.

Inherited Methods
Methods inherited from: Node