Class Reference

Points to a named program element reference

Hierarchy (View Summary)

Joinpoint
- Reference
  - TypeReference

Constructors

constructor

new Reference(obj: any): Reference
Parameters
- obj: any
Returns Reference
Inherited from Joinpoint.constructor
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:32

Properties

`Internal`_javaObject

_javaObject: any

`Static` `Readonly` `Internal`_defaultAttributeInfo

_defaultAttributeInfo: {
    jpMapper?: {
        androidManifest: typeof AndroidManifest;
        annotation: typeof Annotation;
        anonymousExec: typeof AnonymousExec;
        app: typeof App;
        arrayAccess: typeof ArrayAccess;
        assert: typeof Assert;
        assignment: typeof Assignment;
        binaryExpression: typeof BinaryExpression;
        body: typeof Body;
        break: typeof Break;
        call: typeof Call;
        callStatement: typeof CallStatement;
        case: typeof Case;
        catch: typeof Catch;
        class: typeof Class;
        comment: typeof Comment;
        constructor: typeof Constructor;
        continue: typeof Continue;
        declaration: typeof Declaration;
        enum: typeof Enum;
        enumValue: typeof EnumValue;
        executable: typeof Executable;
        expression: typeof Expression;
        field: typeof Field;
        fieldAccess: typeof FieldAccess;
        file: typeof FileJp;
        if: typeof If;
        interfaceType: typeof InterfaceType;
        joinpoint: typeof Joinpoint;
        libClass: typeof LibClass;
        libMethod: typeof LibMethod;
        literal: typeof Literal;
        localVariable: typeof LocalVariable;
        loop: typeof Loop;
        method: typeof Method;
        NamedType: typeof NamedType;
        new: typeof New;
        opAssignment: typeof OpAssignment;
        pragma: typeof Pragma;
        reference: typeof Reference;
        return: typeof Return;
        snippetExpr: typeof SnippetExpr;
        snippetStmt: typeof SnippetStmt;
        statement: typeof Statement;
        switch: typeof Switch;
        ternary: typeof Ternary;
        this: typeof This;
        throw: typeof Throw;
        try: typeof Try;
        type: typeof Type;
        typeReference: typeof TypeReference;
        unaryExpression: typeof UnaryExpression;
        var: typeof Var;
        xmlElement: typeof XmlElement;
        xmlNode: typeof XmlNode;
    };
    map?: DefaultAttributeMap;
    name: string
    | null;
    type?: PrivateMapper;
} = ...

Accessors

annotations

get annotations(): Annotation[]
An array of the annotations of this node

Returns Annotation[]
Inherited from Joinpoint.annotations
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:134

ast

get ast(): string
A string representation of the AST corresponding to this node

Returns string
Inherited from Joinpoint.ast
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:138

astParent

get astParent(): Joinpoint
Alias of attribute 'parent'

Returns Joinpoint
Inherited from Joinpoint.astParent
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:142

children

get children(): Joinpoint[]
Returns an array with the children of the node

Returns Joinpoint[]
Inherited from Joinpoint.children
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:146

code

get code(): string
The source code corresponding to this join point

Returns string
Inherited from Joinpoint.code
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:150

declaration

get declaration(): Joinpoint
The element that is being referenced

Returns Joinpoint
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:492

descendants

get descendants(): Joinpoint[]
Returns Joinpoint[]
Inherited from Joinpoint.descendants
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:151

dump

get dump(): string
Returns string
Inherited from Joinpoint.dump
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:33

id

get id(): string
Unique identifier for node

Returns string
Inherited from Joinpoint.id
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:155

isBlock

get isBlock(): boolean
True if this node is considered a block of statements

Returns boolean
Inherited from Joinpoint.isBlock
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:159

isFinal

get isFinal(): boolean
True if this node has the modifier 'final'

Returns boolean
Inherited from Joinpoint.isFinal
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:163

isInsideLoopHeader

get isInsideLoopHeader(): boolean
True if the node is inside a loop header, false otherwise

Returns boolean
Inherited from Joinpoint.isInsideLoopHeader
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:167

isStatement

get isStatement(): boolean
True if this node is considered a statement

Returns boolean
Inherited from Joinpoint.isStatement
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:171

isStatic

get isStatic(): boolean
True if this node has the modifier 'static'

Returns boolean
Inherited from Joinpoint.isStatic
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:175

joinPointType

get joinPointType(): string
Returns string
Inherited from Joinpoint.joinPointType
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:34

left

get left(): Joinpoint[]
Sibling nodes to the left of this node

Returns Joinpoint[]
Inherited from Joinpoint.left
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:179

line

get line(): number
Returns number
Inherited from Joinpoint.line
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:180
set line(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Joinpoint.line
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:181

modifiers

get modifiers(): string[]
An array of modifiers (e.g., final, static) applied to this node. If no modifiers are applied, or if the node does not support modifiers, returns an empty array

Returns string[]
Inherited from Joinpoint.modifiers
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:185
set modifiers(value: string[]): void
An array of modifiers (e.g., final, static) applied to this node. If no modifiers are applied, or if the node does not support modifiers, returns an empty array
Parameters
- value: string[]
Returns void
Inherited from Joinpoint.modifiers
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:189

name

get name(): string
Name of the element of the reference

Returns string
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:496

node

get node(): object
Returns object
Inherited from Joinpoint.node
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:35

numChildren

get numChildren(): number
Returns the number of children of the node

Returns number
Inherited from Joinpoint.numChildren
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:193

parent

get parent(): Joinpoint
Returns Joinpoint
Inherited from Joinpoint.parent
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:194

right

get right(): Joinpoint[]
Sibling nodes to the right of this node

Returns Joinpoint[]
Inherited from Joinpoint.right
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:198

scopeNodes

get scopeNodes(): LaraJoinPoint[]
Returns LaraJoinPoint[]
Inherited from Joinpoint.scopeNodes
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:40

self

get self(): LaraJoinPoint
Returns LaraJoinPoint
Inherited from Joinpoint.self
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:36

srcCode

get srcCode(): string
Alias for attribute 'code'

Returns string
Inherited from Joinpoint.srcCode
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:202

super

get super(): LaraJoinPoint
Returns LaraJoinPoint
Inherited from Joinpoint.super
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:37

type

get type(): string
Type of the element of the reference

Returns string
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:500

Methods

child

child(index: number): Joinpoint
Returns the child of the node at the given index
Parameters
- index: number
Returns Joinpoint
Inherited from Joinpoint.child
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:206

copy

copy(): Joinpoint
Returns Joinpoint
Inherited from Joinpoint.copy
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:212

equals

equals(jp: LaraJoinPoint): boolean
Parameters
- jp: LaraJoinPoint
Returns boolean
Inherited from Joinpoint.equals
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:44

getAncestor

getAncestor(type: string): Joinpoint
Parameters
- type: string
Returns Joinpoint
Inherited from Joinpoint.getAncestor
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:207

hasModifier

hasModifier(modifier: string): boolean
True if this node has the given modifier
Parameters
- modifier: string
Returns boolean
Inherited from Joinpoint.hasModifier
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:211

insert

insert(position: "replace" | "after" | "before", code: string): LaraJoinPoint[]
Parameters
- position: "replace" | "after" | "before"
- code: string
Returns LaraJoinPoint[]
Inherited from Joinpoint.insert
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:41
insert(
position: "replace" | "after" | "before",
joinpoint: LaraJoinPoint,
): LaraJoinPoint[]
Parameters
- position: "replace" | "after" | "before"
- joinpoint: LaraJoinPoint
Returns LaraJoinPoint[]
Inherited from Joinpoint.insert
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:42

instanceOf

instanceOf(name: string): boolean
Parameters
- name: string
Returns boolean
Inherited from Joinpoint.instanceOf
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:45
instanceOf(names: string[]): boolean
Parameters
- names: string[]
Returns boolean
Inherited from Joinpoint.instanceOf
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:46

remove

remove(): void
Returns void
Inherited from Joinpoint.remove
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:222

removeAnnotation

removeAnnotation(annotation: Annotation): void
Parameters
- annotation: Annotation
Returns void
Inherited from Joinpoint.removeAnnotation
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:223

removeModifier

removeModifier(modifier: string): void
Parameters
- modifier: string
Returns void
Inherited from Joinpoint.removeModifier
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:224

replaceWith

replaceWith(jp: Joinpoint): Joinpoint
Parameters
- jp: Joinpoint
Returns Joinpoint
Inherited from Joinpoint.replaceWith
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:225
replaceWith(code: string): Joinpoint
Parameters
- code: string
Returns Joinpoint
Inherited from Joinpoint.replaceWith
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:226

setLine

setLine(value: number): void
Parameters
- value: number
Returns void
Inherited from Joinpoint.setLine
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:228
setLine(value: string): void
Parameters
- value: string
Returns void
Inherited from Joinpoint.setLine
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:229

setModifiers

setModifiers(modifiers: string[]): void
Parameters
- modifiers: string[]
Returns void
Inherited from Joinpoint.setModifiers
- Defined in kadabra/Kadabra-JS/src-api/Joinpoints.ts:231

toString

toString(): string
Returns string
Inherited from Joinpoint.toString
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:43

Class Reference

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Reference

Properties

Internal_javaObject

Static Readonly Internal_defaultAttributeInfo

Accessors

annotations

Returns Annotation[]

ast

Returns string

astParent

Returns Joinpoint

children

Returns Joinpoint[]

code

Returns string

declaration

Returns Joinpoint

descendants

Returns Joinpoint[]

dump

Returns string

id

Returns string

isBlock

Returns boolean

isFinal

Returns boolean

isInsideLoopHeader

Returns boolean

isStatement

Returns boolean

isStatic

Returns boolean

joinPointType

Returns string

left

Returns Joinpoint[]

line

Returns number

Parameters

Returns void

modifiers

Returns string[]

Parameters

Returns void

name

Returns string

node

Returns object

numChildren

Returns number

parent

Returns Joinpoint

right

Returns Joinpoint[]

scopeNodes

Returns LaraJoinPoint[]

self

Returns LaraJoinPoint

srcCode

Returns string

super

Returns LaraJoinPoint

type

Returns string

Methods

child

Parameters

Returns Joinpoint

copy

`Internal`_javaObject

`Static` `Readonly` `Internal`_defaultAttributeInfo