Package simpleml.lang

Tutorial - Idea and basic concepts | Interface | API | DSL

Table of Contents

• Classes
  • Any
  • Boolean
  • Float
  • Int
  • Nothing
  • Number
  • String
• Enums
  • AnnotationTarget
• Annotations
  • Constant
  • Deprecated
  • Description
  • NoSideEffects
  • Pure
  • PythonModule
  • PythonName
  • Repeatable
  • Since
  • Target

---

Class Any

The common superclass of all classes.

Constructor: Class has no constructor.

---

Class Boolean

A truth value.

Constructor: Class has no constructor.

---

Class Float

A floating-point number.

Constructor: Class has no constructor.

---

Class Int

An integer.

Constructor: Class has no constructor.

---

Class Nothing

The common subclass of all classes.

Constructor: Class has no constructor.

---

Class Number

A number.

Constructor: Class has no constructor.

---

Class String

Some text.

Constructor: Class has no constructor.

Enum AnnotationTarget

The declaration types that can be targeted by annotations.

Enum Variant Annotation

The annotation can be called on annotations.

Parameters: None expected.

Enum Variant Attribute

The annotation can be called on attributes.

Parameters: None expected.

Enum Variant Class

The annotation can be called on classes.

Parameters: None expected.

Enum Variant CompilationUnit

The annotation can be called on compilation units (i.e. files).

Parameters: None expected.

Enum Variant Enum

The annotation can be called on enums.

Parameters: None expected.

Enum Variant EnumVariant

The annotation can be called on enum variants.

Parameters: None expected.

Enum Variant Function

The annotation can be called on functions.

Parameters: None expected.

Enum Variant Parameter

The annotation can be called on parameters.

Parameters: None expected.

Enum Variant Result

The annotation can be called on results.

Parameters: None expected.

Enum Variant Step

The annotation can be called on steps.

Parameters: None expected.

Enum Variant TypeParameter

The annotation can be called on type parameters.

Parameters: None expected.

Enum Variant Workflow

The annotation can be called on workflows.

Parameters: None expected.

Annotation Constant

Values assigned to this parameter must be constant.

Valid targets:

• Parameter

Annotation Deprecated

The declaration should no longer be used.

Parameters:

• alternative: String? = null - What to use instead.
• reason: String? = null - Why the declaration was deprecated.
• sinceVersion: String? = null - When the declaration was deprecated.
• removalVersion: String? = null - When the declaration will be removed.

Valid targets:

• Annotation
• Attribute
• Class
• Enum
• EnumVariant
• Function
• Parameter
• Result
• Step
• TypeParameter

Annotation Description

The purpose of a declaration.

Parameters:

• description: String - The purpose of a declaration.

Valid targets:

• Annotation
• Attribute
• Class
• CompilationUnit
• Enum
• EnumVariant
• Function
• Parameter
• Result
• Step
• TypeParameter
• Workflow

Annotation NoSideEffects

The function has no side effects.

Valid targets:

• Function

Annotation Pure

The function has no side effects and returns the same results for the same arguments.

Valid targets:

• Function

Annotation PythonModule

The qualified name of the corresponding Python module (default is the qualified name of the package).

Parameters:

• qualifiedName: String - The qualified name of the corresponding Python module.

Valid targets:

• CompilationUnit

Annotation PythonName

The name of the corresponding API element in Python (default is the name of the declaration in the stubs).

Parameters:

• name: String - The name of the corresponding API element in Python.

Valid targets:

• Attribute
• Class
• Enum
• EnumVariant
• Function
• Parameter
• Step
• Workflow

Annotation Repeatable

The annotation can be called multiple times for the same declaration.

Valid targets:

• Annotation

Annotation Since

The version in which a declaration was added.

Parameters:

• version: String - The version in which a declaration was added.

Valid targets:

• Annotation
• Attribute
• Class
• CompilationUnit
• Enum
• EnumVariant
• Function
• Parameter
• Result
• Step
• TypeParameter
• Workflow

Annotation Target

The annotation can target these declaration types. If the @Target annotation is not used any declaration type can be targeted.

Parameters:

• vararg targets: AnnotationTarget - The valid targets.

Valid targets:

• Annotation

---

This file was created automatically. Do not change it manually!