HighwayJson

JSON encoding of canonical Highway constructors, declarations and identity references.

Types

For external producers that must encode references before the receiving model is available.

data class Ref(val ref: String)

A reference is encoding machinery; its target type comes from the canonical Kotlin property.

val mapper: JsonMapper

fun read(tree: JsonNode, viewpoints: Set<Viewpoint>? = null, elements: Set<String> = emptySet(), interfaceMetadata: Boolean = true, externalContextOnly: Boolean = false, external: (String) -> MetamodelEntity? = { null }): HighwayModel

fun read(file: File, viewpoints: Set<Viewpoint>? = null, elements: Set<String> = emptySet(), interfaceMetadata: Boolean = true, externalContextOnly: Boolean = false, external: (String) -> MetamodelEntity? = { null }): HighwayModel

fun schema(): JsonNode

Both full object definitions and generic metadata updates derive their fields from Kotlin.

fun tree(model: HighwayModel): ObjectNode