Table of Contents

Class JvmEndpointClass

Namespace
TypedRest.CodeGeneration.Jvm.Model
Assembly
TypedRest.CodeGeneration.Jvm.dll

A generated endpoint class, deriving from one of the TypedRest endpoint implementations.

public sealed class JvmEndpointClass : IJvmType
Inheritance
object
JvmEndpointClass
Implements

Constructors

JvmEndpointClass(JvmIdentifier)

A generated endpoint class, deriving from one of the TypedRest endpoint implementations.

public JvmEndpointClass(JvmIdentifier identifier)

Parameters

identifier JvmIdentifier

The name of the class and the package it is declared in.

Properties

BaseType

The TypedRest endpoint implementation this class derives from.

public JvmIdentifier BaseType { get; set; }

Property Value

JvmIdentifier

Children

The child endpoints exposed by the class.

public List<JvmChildEndpoint> Children { get; }

Property Value

List<JvmChildEndpoint>

Constructor

The constructor of the class, or null to inherit the base constructor.

public JvmConstructor? Constructor { get; set; }

Property Value

JvmConstructor

Deprecated

Marks the type as deprecated.

public bool Deprecated { get; set; }

Property Value

bool

Identifier

The name of the type and the package it is declared in.

public JvmIdentifier Identifier { get; }

Property Value

JvmIdentifier

Interface

The generated interface this class implements, or null when interfaces are not being generated.

public JvmIdentifier? Interface { get; set; }

Property Value

JvmIdentifier

Summary

A description of the type for a JavaDoc/KDoc comment.

public string? Summary { get; set; }

Property Value

string

Methods

GetImports()

Returns every type that has to be imported by the file declaring this type.

public IEnumerable<JvmIdentifier> GetImports()

Returns

IEnumerable<JvmIdentifier>