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

AdditionalPropertyInterface

class AdditionalPropertyInterface(nullable: Boolean, val valueType: FieldType, name: String, topInterfaceName: ValidFieldName, additionalPropertyPaths: List<JsonPath>, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = true) : OpenApiMarker.Interface

Special type of Interface that inherits AdditionalProperty. Also generates different read-methods in DefaultReadOpenApiMethod including automatic conversion to AdditionalProperty.

Parameters

nullable

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

valueType

the type of the value of the AdditionalProperty.

name

the name of the interface.

visibility

the visibility of the interface.

Constructors

AdditionalPropertyInterface

constructor(nullable: Boolean, valueType: FieldType, name: String, topInterfaceName: ValidFieldName, additionalPropertyPaths: List<JsonPath>, 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 = true

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

val valueType: FieldType

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.AdditionalPropertyInterface

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