core/org.jetbrains.kotlinx.dataframe.io/SupportedCodeGenerationFormat

SupportedCodeGenerationFormat

interface SupportedCodeGenerationFormat : SupportedFormat

Implement this interface to provide additional DataSchema interface generation formats for DataFrames (such as OpenAPI). Note, this doesn't add functionality to DataFrame.Companion.read, just ImportDataSchema and Gradle plugin.

Return type will be a Code which contains a generated interface with the given name containing generated DataSchema interfaces and enums, with typealiases (and optional extension functions in some integration) outside the interface.

Properties

testOrder

abstract val testOrder: Int

Functions

acceptsExtension

abstract fun acceptsExtension(ext: String): Boolean

acceptsSample

abstract fun acceptsSample(sample: SupportedFormatSample): Boolean

createDefaultReadMethod

abstract fun createDefaultReadMethod(pathRepresentation: String? = null): DefaultReadDfMethod

readCodeForGeneration

abstract fun readCodeForGeneration(file: File, name: String, generateHelperCompanionObject: Boolean = false): Code

abstract fun readCodeForGeneration(stream: InputStream, name: String, generateHelperCompanionObject: Boolean = false): Code

internal infix fun SupportedCodeGenerationFormat.to(code: Code): GeneratedCode