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

MarkerAlias

class MarkerAlias(superMarker: OpenApiMarker, topInterfaceName: ValidFieldName, nullable: Boolean, name: String, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = false) : OpenApiMarker

A Marker that will be used to generate a type alias that points at another Marker.

Parameters

superMarker

the type that the type alias points at.

nullable

whether the typealias points at a nullable type.

name

the name of the type alias.

visibility

the visibility of the type alias.

Constructors

constructor(superMarker: OpenApiMarker, topInterfaceName: ValidFieldName, nullable: Boolean, name: String, visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC, prependTopInterfaceName: Boolean = false)

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

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

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