Class ReturnStmt

Return statement with an optional return value.

Hierarchy (View Summary)

Constructors

constructor

Accessors

code id identifier node supported type value

Methods

elements hasValue stream

Constructors

constructor

Accessors

code

  • get code(): string

    Get the original line of code in the source file.

    All values in one node share the same code.

    Returns string

    The original

id

  • get id(): number

    Get the id of the vertex in the graph database this value represents.

    Returns number

  • set id(id: number): void
    Internal

    Parameters

    • id: number

    Returns void

identifier

  • get identifier(): string

    The syntax component identifier, i.e. ArkAssignStmt.

    Returns string

    The identifier.

node

  • get node(): CodeNode

    Get the node in the graph database this value is associated with.

    Value only represents the AST of the node in the database, use this method to get the complete node, see CodeNode | CodeNode for more information.

    FIXME: All values should be associated with CodeNode, so no type check is performed here.

    Returns CodeNode

    The complete node in the graph database this value is associated with.

supported

  • get supported(): boolean

    Values that cannot be parsed from AST will be marked as unsupported. Usually, only InvalidValue should be marked as unsupported.

    Returns boolean

    Whether this value is supported by the current implementation.

type

  • get type(): Type

    By default, the value has an invalid type, see InvalidType.

    Returns Type

    The type of this value.

  • set type(type: Type): void

    Parameters

    • type: Type

    Returns void

value

  • get value(): undefined | Value

    Get the return value.

    Returns undefined | Value

    The return value, or undefined if there is no return value.

Methods

Protectedelements

hasValue

  • hasValue(): boolean

    Check if the return statement has a return value.

    Returns boolean

    true if the return statement has a value, false otherwise.

stream

  • stream(): Stream<Value>

    This method is used to get the stream representation of this value. It depends on the implementation of the elements method.

    See Stream for stream operations.

    Returns Stream<Value>

    A stream of values.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods