Class JvmEndpointInterface

Namespace

TypedRest.CodeGeneration.Jvm.Model

Assembly

TypedRest.CodeGeneration.Jvm.dll

A generated endpoint interface, extending the TypedRest interface behind the endpoint kind.

public sealed class JvmEndpointInterface : IJvmType

Inheritance

object

JvmEndpointInterface

Implements

IJvmType

Remarks

Generated only when interfaces are turned on, declaring the same children as the class implementing it.

Constructors

JvmEndpointInterface(JvmIdentifier)

A generated endpoint interface, extending the TypedRest interface behind the endpoint kind.

public JvmEndpointInterface(JvmIdentifier identifier)

Parameters

identifier JvmIdentifier

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

Remarks

Generated only when interfaces are turned on, declaring the same children as the class implementing it.

Properties

BaseType

The TypedRest endpoint interface this one extends, or null for an endpoint kind that has none.

public JvmIdentifier? BaseType { get; set; }

Property Value

JvmIdentifier

Children

The child endpoints declared by the interface.

public List<JvmChildEndpoint> Children { get; }

Property Value

List<JvmChildEndpoint>

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

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>