A module descriptor: a list of annotations, followed by the keyword ‘module’, the module name, an optional specifier, and the module version and body.

Examples (multi-line):

module tmp "1.0.0" {}

"Tests for the [[ceylon.ast.core module|module ceylon.ast.core]]"
by ("Lucas Werkmeister <mail@lucaswerkmeister.de>")
license ("http://www.apache.org/licenses/LICENSE-2.0.html")
module test.ceylon.ast.core "1.2.0" {
    shared import ceylon.test "1.2.0";
    import ceylon.ast.core "1.2.0";
}

no subtypes hierarchy

Initializer
ModuleDescriptor(ModuleName name, StringLiteral version, ModuleBody body = ..., Annotations annotations = ..., ModuleSpecifier? specifier = ...)
Parameters:
  • name

    The module name.

  • version

    The module version.

    (No constraints on the version – allowed characters, length, etc. – are specified, but some versions crash the compiler, and constraints will likely be specified at some point.)

  • body = y = ModuleBo

    The module body.

  • annotations = s = Annotatio

    The module’s annotations. The most commonly used are:

    • documentation
    • license
    • by
  • specifier = r =

    The module specifier, defining a mapping to a foreign module system to which the module will be exported, if present.

Attributes
annotationsSource Codeshared Annotations annotations

The module’s annotations. The most commonly used are:

  • documentation
  • license
  • by
bodySource Codeshared ModuleBody body

The module body.

childrenSource Codeshared actual [Annotations, ModuleName, ModuleSpecifier, StringLiteral, ModuleBody]|[Annotations, ModuleName, StringLiteral, ModuleBody] 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.

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

The module name.

specifierSource Codeshared ModuleSpecifier? specifier

The module specifier, defining a mapping to a foreign module system to which the module will be exported, if present.

versionSource Codeshared StringLiteral version

The module version.

(No constraints on the version – allowed characters, length, etc. – are specified, but some versions crash the compiler, and constraints will likely be specified at some point.)

Inherited Attributes
Attributes inherited from: Node
Attributes inherited from: Object
hash, string
Methods
copySource Codeshared ModuleDescriptor copy(ModuleName name = ..., StringLiteral version = ..., ModuleBody body = ..., Annotations annotations = ..., ModuleSpecifier? specifier = ...)
Parameters:
  • name = me name =
  • version = version = th
  • body = dy body =
  • annotations = tations = this.a
  • specifier = ecifier = this
equalsSource Codeshared 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, as long as the class does not inherit Identifiable. 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
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.

visitSource Codeshared 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