A function definition, using a block.

Exampes (multi-line):

shared void run() {
    print("Hello, `` process.arguments.first else "World" ``!");
}
shared actual Boolean equals(Object that) {
    if (is Color that) {
        return red == that.red && green == that.green && blue == that.blue;
    } else {
        return false;
    }
}

no subtypes hierarchy

Initializer
FunctionDefinition(LIdentifier name, Type|VoidModifier|FunctionModifier|DynamicModifier type, [Parameters+] parameterLists, Block definition, TypeParameters? typeParameters = null, TypeConstraint[] typeConstraints = [], Annotations annotations = ...)
Parameters:
  • name

    The name of the declared program element, if present.

  • type

    The type of the function.

    This can be:

    • a Type,
    • a void’ modifier (VoidModifier) for a function that does not return a value,
    • a function’ modifier (FunctionModifier) for a function with inferred type,
    • a dynamic’ modifier (DynamicModifier) for a dynamically typed function.
  • parameterLists

    The parameter lists. A function must have at least one, but may also have several parameter lists.

  • definition

    The definition of the declaration, if present.

  • typeParameters = null

    The type parameters of the function, if any.

  • typeConstraints = []

    The type constraints placed upon the function’s type parameters, if any.

  • annotations = Annotations()

    The annotations on the declaration.

Attributes
annotationsshared actual Annotations annotations

The annotations on the declaration.

childrenshared actual [Annotations, Type|FunctionModifier|DynamicModifier|VoidModifier, LIdentifier, <TypeParameters|Parameters|TypeConstraint|Block>*] children

The child nodes of this node.

Refines AnyFunction.children ultimately refines Node.children
definitionshared actual Block definition

The definition of the declaration, 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 declared program element, if present.

Refines AnyFunction.name ultimately refines Declaration.name
parameterListsshared actual [Parameters+] parameterLists

The parameter lists. A function must have at least one, but may also have several parameter lists.

typeshared actual Type|VoidModifier|FunctionModifier|DynamicModifier type

The type of the function.

This can be:

  • a Type,
  • a void’ modifier (VoidModifier) for a function that does not return a value,
  • a function’ modifier (FunctionModifier) for a function with inferred type,
  • a dynamic’ modifier (DynamicModifier) for a dynamically typed function.
Refines AnyFunction.type ultimately refines TypedDeclaration.type
typeConstraintsshared actual TypeConstraint[] typeConstraints

The type constraints placed upon the function’s type parameters, if any.

typeParametersshared actual TypeParameters? typeParameters

The type parameters of the function, if any.

Inherited Attributes
Attributes inherited from: AnyFunction
Attributes inherited from: Declaration
Attributes inherited from: Node
Attributes inherited from: Object
hash, string
Attributes inherited from: TypedDeclaration
Methods
copyshared FunctionDefinition copy(LIdentifier name = ..., Type|VoidModifier|FunctionModifier|DynamicModifier type = ..., [Parameters+] parameterLists = ..., Block definition = ..., TypeParameters? typeParameters = ..., TypeConstraint[] typeConstraints = ..., Annotations annotations = ...)
Parameters:
  • name = this.name
  • type = this.type
  • parameterLists = this.parameterLists
  • definition = this.definition
  • typeParameters = this.typeParameters
  • typeConstraints = this.typeConstraints
  • 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