dataframe-openapi-generator/org.jetbrains.kotlinx.dataframe.io/OpenApiMarker/Enum

Enum

class Enum(nullable: Boolean, fields: List<GeneratedField>, name: String, topInterfaceName: ValidFieldName, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = true) : OpenApiMarker

A Marker that will be used to generate an enum.

Parameters

nullable

whether the enum can be null. Needs to be checked when referring to this Marker.

fields

the fields of the enum, can be created using generatedEnumFieldOf.

name

the name of the enum.

visibility

the visibility of the enum.

Constructors

constructor(nullable: Boolean, fields: List<GeneratedField>, name: String, topInterfaceName: ValidFieldName, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = true)

Properties

additionalPropertyPaths

open override val additionalPropertyPaths: List<JsonPath>

val allFields: List<GeneratedField>

allFieldsByColumn

val allFieldsByColumn: Map<String, GeneratedField>

allSuperMarkers

val allSuperMarkers: Map<String, Marker>

val columnNames: List<String>

open override val fields: List<GeneratedField>

open override val isObject: Boolean = false

val isOpen: Boolean

open override val name: String

val nullable: Boolean

val schema: DataFrameSchema

val shortName: String

val superMarkers: Map<String, Marker>

topInterfaceName

protected val topInterfaceName: ValidFieldName

open override val typeArguments: String

open override val typeParameters: String

open override val visibility: MarkerVisibility

Functions

fun containsColumn(columnName: String): Boolean

fun getField(columnName: String): GeneratedField?

fun implements(schema: Marker): Boolean

fun implementsAll(schemas: Iterable<Marker>): Boolean

open override fun toFieldType(): FieldType

open override fun toString(): String

open override fun withName(name: String, prependTopInterfaceName: Boolean = true): OpenApiMarker.Enum

open override fun withVisibility(visibility: MarkerVisibility): OpenApiMarker.Enum