moduleceylon.ast.core1.3.3
Source Code
ceylon.ast.core
classCompilationUnit
extends AnyCompilationUnit
OverviewPackageInitializerAttributesMethods

A regular compilation unit, containing toplevel type, value, or function definitions.

This is the most commonly used type of compilation unit, and the basic “container” for your declarations.

Examples:

void run() {
    print("Hello, World!");
}

// end of example, start of next example

import ceylon.collection {
    SetMutator
}

MyPlugin myPlugin = MyPlugin(); // only instance

register
shared void registerMyPlugin(SetMutator<Plugin> registry)
    => registry.put(myPlugin);

no subtypes hierarchy

Initializer
CompilationUnit(Declaration[] declarations, Import[] imports = ...)
Parameters:
  • declarations

    The declarations in this compilation unit.

    (This attribute is empty for non-regular compilation units.)

  • imports = s

    The imports of this compilation unit.

Attributes
childrenSource Codeshared actual <Import|Declaration>[] children

The child nodes of this node.

Refines AnyCompilationUnit.children ultimately refines Node.children
declarationsSource Codeshared actual Declaration[] declarations

The declarations in this compilation unit.

(This attribute is empty for non-regular compilation units.)

Refines AnyCompilationUnit.declarations
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
importsSource Codeshared actual Import[] imports

The imports of this compilation unit.

Refines AnyCompilationUnit.imports
moduleDescriptorSource Codeshared actual Null moduleDescriptor

Regular compilation units contain no module descriptor.

Refines AnyCompilationUnit.moduleDescriptor
packageDescriptorSource Codeshared actual Null packageDescriptor

Regular compilation units contain no package descriptor.

Refines AnyCompilationUnit.packageDescriptor
Inherited Attributes
Attributes inherited from: AnyCompilationUnit
children, declarations, imports, moduleDescriptor, packageDescriptor
Attributes inherited from: Node
children, data, string
Attributes inherited from: Object
hash, string
Methods
copySource Codeshared CompilationUnit copy(Declaration[] declarations = ..., Import[] imports = ...)
Parameters:
  • declarations = ons = this.declar
  • imports = rts = this.i
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.

Refines Node.transform
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
copyExtraInfoTo(), delete(), get(), getObject(), put(), remove(), set(), transform(), transformChildren(), visit(), visitChildren()
Methods inherited from: Object
equals