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

Interface

open class Interface(nullable: Boolean, fields: List<GeneratedField>, superMarkers: List<Marker>, name: String, topInterfaceName: ValidFieldName, val additionalPropertyPaths: List<JsonPath>, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = true) : OpenApiMarker

A Marker that will be used to generate an interface.

Parameters

nullable

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

fields

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

name

the name of the interface.

visibility

the visibility of the interface.

Inheritors

AdditionalPropertyInterface

Constructors

constructor(nullable: Boolean, fields: List<GeneratedField>, superMarkers: List<Marker>, 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

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

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