Table of Contents

Class JvmGenerationOptions

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

Options controlling the generation of a JVM TypedRest client, shared by the Java and Kotlin generators.

public abstract class JvmGenerationOptions : ClientGenerationOptions
Inheritance
object
JvmGenerationOptions
Derived
Inherited Members

Constructors

JvmGenerationOptions(string)

Creates new generation options.

protected JvmGenerationOptions(string serviceName)

Parameters

serviceName string

The service name to use for the entry endpoint.

JvmGenerationOptions(ClientGenerationOptions)

Creates new generation options, copying the common options from other.

protected JvmGenerationOptions(ClientGenerationOptions other)

Parameters

other ClientGenerationOptions

Fields

DefaultDtoSubPackage

The package name DTOs go into when DtoNamespace is not set, relative to the endpoint package.

public const string DefaultDtoSubPackage = "dtos"

Field Value

string

Properties

DefaultSerializerName

The name of the serializer this target language uses when none is chosen.

protected abstract string DefaultSerializerName { get; }

Property Value

string

DtoPackage

The package the DTOs are generated into.

public string DtoPackage { get; }

Property Value

string

Remarks

Defaults to a DefaultDtoSubPackage subpackage of the endpoints.

EndpointPackage

The package the endpoints are generated into.

public string EndpointPackage { get; }

Property Value

string

UntypedFallback

The type to use for schemas that carry no usable type information.

public JvmIdentifier UntypedFallback { get; set; }

Property Value

JvmIdentifier

Methods

NamingStrategy()

Builds a NamingStrategy applying the package fallbacks.

public NamingStrategy NamingStrategy()

Returns

NamingStrategy

ResolveSerializer()

Resolves Serializer to the serializer to generate for.

public JvmSerializer ResolveSerializer()

Returns

JvmSerializer

Exceptions

ArgumentException

The serializer is not one of SupportedSerializers.

Edit this page