A value constructor definition.

A value constructor definition has the following components:

Examples (multi-line):

shared new origin {
    x = 0.0; y = 0.0;
    r = 0.0; φ = 0.0;
}

shared new red {
    rgb = #FF0000;
}

no subtypes hierarchy

Initializer
ValueConstructorDefinition(LIdentifier name, Block block, ExtendedType? extendedType, Annotations annotations)
Parameters:
  • name

    The name of the constructor.

  • block

    The block of the constructor.

  • extendedType

    The extended type of the constructor, if present.

  • annotations

    The annotations of the constructor.

Attributes
annotationsshared actual Annotations annotations

The annotations of the constructor.

blockshared actual Block block

The block of the constructor.

childrenshared actual <Annotations|LIdentifier|ExtendedType|Block>[] children

The child nodes of this node.

extendedTypeshared actual ExtendedType? extendedType

The extended type of the constructor, if present.

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
nameshared actual LIdentifier name

The name of the constructor.

Refines ConstructorDefinition.name ultimately refines Declaration.name
parametersshared actual Parameters? parameters

The parameters of the constructor, if applicable.

Callable constructors have parameters, value constructors do not.

Inherited Attributes
Attributes inherited from: ConstructorDefinition
Attributes inherited from: Declaration
Attributes inherited from: Node
Attributes inherited from: Object
hash, string
Methods
copyshared ValueConstructorDefinition copy(LIdentifier name = ..., Block block = ..., ExtendedType? extendedType = ..., Annotations annotations = ...)
Parameters:
  • name = this.name
  • block = this.block
  • extendedType = this.extendedType
  • annotations = this.annotations
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
equals