com.shakelang.shake.compiler.processor/com.shakelang.shake.processor.program.types/ShakeClass

ShakeClass

A ShakeClass is a class in the Shake programming language

class MyClass {
   // ...
}

Inheritors

CreationShakeClass

Properties

allFields

open val allFields: List<ShakeField>

All instance-fields of this class (including fields defined in superclasses and interfaces) Overridden fields are not included

allMethods

open val allMethods: List<ShakeMethod>

All instance-methods of this class (including methods defined in superclasses and interfaces) Overridden methods are not included

classes

abstract val classes: List<ShakeClass>

The classes of this class

clazz

abstract val clazz: ShakeClass?

The class this class is in. This is null if the class is not within a class

constructors

abstract val constructors: List<ShakeConstructor>

The constructors of this class

fields

abstract val fields: List<ShakeField>

The fields of this class

instanceClasses

open val instanceClasses: List<ShakeClass>

The instance classes of this class

instanceFields

open val instanceFields: List<ShakeField>

The instance fields of this class

instanceMethods

open val instanceMethods: List<ShakeMethod>

The instance methods of this class

instanceScope

abstract val instanceScope: ShakeScope

The project this class is in. This also keeps the project if this class is inside of a package or class

interfaces

abstract val interfaces: List<ShakeClass>

The interfaces of this class

isAbstract

abstract val isAbstract: Boolean

Is this class abstract?

isAnnotation

abstract val isAnnotation: Boolean

Is this class an annotation?

isEnum

abstract val isEnum: Boolean

Is this class an enum?

isFinal

abstract val isFinal: Boolean

Is this class final?

isInterface

abstract val isInterface: Boolean

Is this class an interface?

isNative

abstract val isNative: Boolean

Is this class native?

isObject

abstract val isObject: Boolean

Is this class an object?

isPrivate

abstract val isPrivate: Boolean

Is this class private?

isProtected

abstract val isProtected: Boolean

Is this class protected?

isPublic

abstract val isPublic: Boolean

Is this class public?

isStatic

abstract val isStatic: Boolean

Is this class static?

methods

abstract val methods: List<ShakeMethod>

The methods of this class

name

abstract val name: String

The (simple) name of this class

parentScope

abstract val parentScope: ShakeScope

The parent scope of this class. The class's scope will extend this scope.

pkg

abstract val pkg: ShakePackage?

The package this class is in. Also holds the package if this class is in a class

prj

abstract val prj: ShakeProject

The project this class is in. This also keeps the project if this class is inside of a package or class

qualifiedName

open val qualifiedName: String

The qualified name of this class (including the package and parent classes)

qualifierPrefix

open val qualifierPrefix: String

The prefix for child entities (classes, fields, methods, ...) of this class

signature

open val signature: String

The signature of this class (including the package and parent classes)

staticClasses

open val staticClasses: List<ShakeClass>

The static classes of this class

staticFields

open val staticFields: List<ShakeField>

The static fields of this class

staticMethods

open val staticMethods: List<ShakeMethod>

The static methods of this class

staticScope

abstract val staticScope: ShakeScope

The project this class is in. This also keeps the project if this class is inside of a package or class

superClass

abstract val superClass: ShakeClass

The superclass of this class

Functions

compatibilityDistance

open fun compatibilityDistance(other: ShakeClass): Int

The compatibility distance between this class and the other class

compatibleTo

open fun compatibleTo(other: ShakeClass): Boolean

Is this class compatible to the other class?

getClass

open fun getClass(descriptor: Array<String>): ShakeClass?

open fun getClass(descriptor: String): ShakeClass?

open fun getClass(descriptor: List<String>): ShakeClass?

Get a child class

getField

open fun getField(descriptor: Array<String>): ShakeField?

open fun getField(descriptor: String): ShakeField?

open fun getField(descriptor: List<String>): ShakeField?

Get a child field

getMethods

open fun getMethods(descriptor: Array<String>): List<ShakeMethod>

open fun getMethods(descriptor: String): List<ShakeMethod>

open fun getMethods(descriptor: List<String>): List<ShakeMethod>

Get a child method

phase1

abstract fun phase1()

Processor phase 1 action

phase2

abstract fun phase2()

Processor phase 2 action

phase3

abstract fun phase3()

Processor phase 3 action

phase4

abstract fun phase4()

Processor phase 4 action

toJson

open fun toJson(): Map<String, Any?>

Get the json representation of this class