An annotation.

For the common case “no arguments”, the toplevel helper function annotation() may be used.

Examples:

shared
formal
by ("John Doe <john.doe@company.com>")
see (`function print`)
action { description = "Log in"; url = "/login"; }

no subtypes hierarchy

Initializer
Annotation(MemberName name, Arguments? arguments = null)
Parameters:
  • name

    The name of the annotation constructor.

  • arguments = null

    The arguments, or null if they’re completely omitted.

Attributes
argumentsSource Codeshared Arguments? arguments

The arguments, or null if they’re completely omitted.

childrenSource Codeshared actual [LIdentifier, Arguments=] children

The child nodes of this node.

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
nameSource Codeshared MemberName name

The name of the annotation constructor.

Inherited Attributes
Attributes inherited from: Node
Attributes inherited from: Object
Methods
copySource Codeshared Annotation copy(LIdentifier name = ..., Arguments? arguments = ...)
Parameters:
  • name = this.name
  • arguments = this.arguments
equalsSource Codeshared 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.

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