A regular interface definition.

An interface definition has the following components:

Examples (multi-line):

shared interface Printable {
    shared default void print() => package.print(this);
}

shared interface Numeric<Other> of Other
        satisfies Invertible<Other>
        given Other satisfies Numeric<Other> {
    shared formal Other times(other);
    shared formal Other divided(other);
}

no subtypes hierarchy

Initializer
InterfaceDefinition(UIdentifier name, InterfaceBody body, CaseTypes? caseTypes = null, SatisfiedTypes? satisfiedTypes = null, TypeParameters? typeParameters = null, TypeConstraint[] typeConstraints = [], Annotations annotations = ...)
Parameters:
  • name

    The name of the interface.

  • body

    The body of the interface.

  • caseTypes = null

    The case types of the interface, if present.

  • satisfiedTypes = null

    The satisfied types of the interface, if present.

  • typeParameters = null

    The type parameters of the interface, if present.

  • typeConstraints = []

    The type constraints of the interface, if any.

  • annotations = Annotations()

    The annotations of the interface.

Attributes
annotationsshared actual Annotations annotations

The annotations of the interface.

bodyshared actual InterfaceBody body

The body of the interface.

caseTypesshared actual CaseTypes? caseTypes

The case types of the interface, if present.

childrenshared actual <Annotations|UIdentifier|TypeParameters|CaseTypes|SatisfiedTypes|TypeConstraint|InterfaceBody>[] children

The child nodes of this node.

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.

In general, hash values vary between platforms and between executions of the same program.

Note that when executing on a Java Virtual Machine, the 64-bit Integer value returned by an implementation of hash is truncated to a 32-bit integer value by taking the exclusive disjunction of the 32 lowest-order bits with the 32 highest-order bits, before returning the value to the caller.

Refines Object.hash
nameshared actual UIdentifier name

The name of the interface.

Refines TypeDeclaration.name ultimately refines Declaration.name
satisfiedTypesshared actual SatisfiedTypes? satisfiedTypes

The satisfied types of the interface, if present.

typeConstraintsshared actual TypeConstraint[] typeConstraints

The type constraints of the interface, if any.

typeParametersshared actual TypeParameters? typeParameters

The type parameters of the interface, if present.

Inherited Attributes
Attributes inherited from: AnyInterfaceDefinition
Attributes inherited from: ClassOrInterface
Attributes inherited from: Declaration
Attributes inherited from: Node
Attributes inherited from: Object
hash, string
Attributes inherited from: TypeDeclaration
Methods
copyshared InterfaceDefinition copy(UIdentifier name = ..., InterfaceBody body = ..., CaseTypes? caseTypes = ..., SatisfiedTypes? satisfiedTypes = ..., TypeParameters? typeParameters = ..., TypeConstraint[] typeConstraints = ..., Annotations annotations = ...)
Parameters:
  • name = this.name
  • body = this.body
  • caseTypes = this.caseTypes
  • satisfiedTypes = this.satisfiedTypes
  • typeParameters = this.typeParameters
  • typeConstraints = this.typeConstraints
  • annotations = this.annotations
equalsshared actual Boolean equals(Object that)

Determine if two values are equal.

For any two non-null objects x and y, x.equals(y) may be written as:

x == y 

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.

Note that an implementation of equals() that always returns false does satisfy the constraints given above. Therefore, in very rare cases where there is no reasonable definition of value equality for a class, for example, function references (Callable), it is acceptable for equals() to be defined to return false for every argument.

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