Class JvmDtoProperty

Namespace

TypedRest.CodeGeneration.Jvm.Model

Assembly

TypedRest.CodeGeneration.Jvm.dll

A property of a generated DTO.

public sealed class JvmDtoProperty

Inheritance

object

JvmDtoProperty

Constructors

JvmDtoProperty(string, string, JvmIdentifier)

A property of a generated DTO.

public JvmDtoProperty(string name, string wireName, JvmIdentifier type)

Parameters

name string

The name of the property in generated code.

wireName string

The name of the property on the wire.

type JvmIdentifier

The type of the property.

Properties

Deprecated

Marks the property as deprecated.

public bool Deprecated { get; set; }

Property Value

bool

Name

The name of the property in generated code.

public string Name { get; }

Property Value

string

Required

Indicates whether the document marks this property as required.

public bool Required { get; set; }

Property Value

bool

Summary

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

public string? Summary { get; set; }

Property Value

string

Type

The type of the property.

public JvmIdentifier Type { get; }

Property Value

JvmIdentifier

WireName

The name of the property on the wire, which the serializer annotation carries when it differs from Name.

public string WireName { get; }

Property Value

string

Methods

GetImports()

Returns every type that has to be imported to declare this property.

public IEnumerable<JvmIdentifier> GetImports()

Returns

IEnumerable<JvmIdentifier>