moduleceylon.ast.core1.2.2
ceylon.ast.core
classClassDefinition
extends AnyClass
OverviewPackageInitializerAttributesMethods

A class definition.

A class definition has the following components:

Examples (multi-line):

shared class PrintableWrapper<T>(shared T wrapped)
        satisfies Printable {
    shared actual void print() {
        package.print(wrapped else "<null>");
    }
}

shared class Counter(Integer initialCount=0) {

    variable Integer n = initialCount;

    shared Integer count => n;

    shared void increment() => n++;
}

no subtypes hierarchy

Initializer
ClassDefinition(UIdentifier name, Parameters? parameters, ClassBody body, CaseTypes? caseTypes = null, ExtendedType? extendedType = null, SatisfiedTypes? satisfiedTypes = null, TypeParameters? typeParameters = null, TypeConstraint[] typeConstraints = [], Annotations annotations = ...)
Parameters:
  • name

    The name of the class.

  • parameters

    The parameters of the class.

  • body

    The body of the class.

  • caseTypes = null

    The case types of the class.

  • extendedType = null

    The extended type of the class.

  • satisfiedTypes = null

    The satisfied types of the class.

  • typeParameters = null

    The type parameters of the class.

  • typeConstraints = []

    The type constraints on the class’ type parameters.

  • annotations = Annotations()

    The annotations of the class.

Attributes
annotationsshared actual Annotations annotations

The annotations of the class.

Refines Declaration.annotations
bodyshared ClassBody body

The body of the class.

caseTypesshared actual CaseTypes? caseTypes

The case types of the class.

Refines ClassOrInterface.caseTypes
childrenshared actual <Annotations|UIdentifier|TypeParameters|Parameters|CaseTypes|ExtendedType|SatisfiedTypes|TypeConstraint|ClassBody>[] children

The child nodes of this node.

Refines Node.children
extendedTypeshared actual ExtendedType? extendedType

The extended type of the class.

Refines AnyClass.extendedType
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 removal of the 32 highest order bits, before returning the value to the caller.

Refines Object.hash
nameshared actual UIdentifier name

The name of the class.

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

The parameters of the class.

Refines AnyClass.parameters
satisfiedTypesshared actual SatisfiedTypes? satisfiedTypes

The satisfied types of the class.

Refines ClassOrInterface.satisfiedTypes
typeConstraintsshared actual TypeConstraint[] typeConstraints

The type constraints on the class’ type parameters.

Refines TypeDeclaration.typeConstraints
typeParametersshared actual TypeParameters? typeParameters

The type parameters of the class.

Refines TypeDeclaration.typeParameters
Inherited Attributes
Attributes inherited from: AnyClass
extendedType, parameters
Attributes inherited from: ClassOrInterface
caseTypes, satisfiedTypes
Attributes inherited from: Declaration
annotations, name
Attributes inherited from: Node
children, data, string
Attributes inherited from: Object
hash, string
Attributes inherited from: TypeDeclaration
name, typeConstraints, typeParameters
Methods
copyshared ClassDefinition copy(UIdentifier name = ..., Parameters? parameters = ..., ClassBody body = ..., CaseTypes? caseTypes = ..., ExtendedType? extendedType = ..., SatisfiedTypes? satisfiedTypes = ..., TypeParameters? typeParameters = ..., TypeConstraint[] typeConstraints = ..., Annotations annotations = ...)
Parameters:
  • name = this.name
  • parameters = this.parameters
  • body = this.body
  • caseTypes = this.caseTypes
  • extendedType = this.extendedType
  • satisfiedTypes = this.satisfiedTypes
  • 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.

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.

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