Kotlin examples

Simple model

A simple model with some scalar properties.

{
  "definitions": {
    "Student": {
      "description": "A simple student struct",
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    }
  },
  "root": "Student"
}

Student.kt


import com.fasterxml.jackson.annotation.*

/**
 * A simple student struct
 */
open class Student {
    @JsonProperty("firstName") var firstName: String? = null
    @JsonProperty("lastName") var lastName: String? = null
    @JsonProperty("age") var age: Int? = null
}

Model with inheritance

A student struct which extends from a different struct.

{
  "definitions": {
    "Human": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    },
    "Student": {
      "parent": {
        "type": "reference",
        "target": "Human"
      },
      "type": "struct",
      "properties": {
        "studentId": {
          "type": "string"
        }
      }
    }
  },
  "root": "Student"
}

Human.kt


import com.fasterxml.jackson.annotation.*

open class Human {
    @JsonProperty("firstName") var firstName: String? = null
    @JsonProperty("lastName") var lastName: String? = null
    @JsonProperty("age") var age: Int? = null
}

Student.kt


import com.fasterxml.jackson.annotation.*

open class Student : Human {
    @JsonProperty("studentId") var studentId: String? = null
}

Model with reference

A student struct which reference a faculty struct.

{
  "definitions": {
    "Student": {
      "description": "A student struct with an assigned faculty",
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        },
        "faculty": {
          "type": "reference",
          "target": "Faculty"
        }
      }
    },
    "Faculty": {
      "type": "struct",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    }
  },
  "root": "Student"
}

Student.kt


import com.fasterxml.jackson.annotation.*

/**
 * A student struct with an assigned faculty
 */
open class Student {
    @JsonProperty("firstName") var firstName: String? = null
    @JsonProperty("lastName") var lastName: String? = null
    @JsonProperty("age") var age: Int? = null
    @JsonProperty("faculty") var faculty: Faculty? = null
}

Faculty.kt


import com.fasterxml.jackson.annotation.*

open class Faculty {
    @JsonProperty("name") var name: String? = null
}

Map with string values

A student struct which contains a map with arbitrary string values.

{
  "definitions": {
    "Student": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        },
        "properties": {
          "type": "map",
          "schema": {
            "type": "string"
          }
        }
      }
    }
  },
  "root": "Student"
}

Student.kt


import com.fasterxml.jackson.annotation.*

open class Student {
    @JsonProperty("firstName") var firstName: String? = null
    @JsonProperty("lastName") var lastName: String? = null
    @JsonProperty("age") var age: Int? = null
    @JsonProperty("properties") var properties: HashMap<String, String>? = null
}

Model with discriminator

A struct which uses a discriminator mapping.

{
  "definitions": {
    "Human": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "location": {
          "type": "reference",
          "target": "Location"
        }
      }
    },
    "Location": {
      "type": "struct",
      "base": true,
      "properties": {
        "type": {
          "type": "string"
        }
      },
      "discriminator": "type",
      "mapping": {
        "Web": "web",
        "World": "world"
      }
    },
    "Web": {
      "parent": {
        "type": "reference",
        "target": "Location"
      },
      "type": "struct",
      "properties": {
        "url": {
          "type": "string"
        }
      }
    },
    "World": {
      "parent": {
        "type": "reference",
        "target": "Location"
      },
      "type": "struct",
      "properties": {
        "lat": {
          "type": "string"
        },
        "long": {
          "type": "string"
        }
      }
    }
  },
  "root": "Human"
}

Human.kt


import com.fasterxml.jackson.annotation.*

open class Human {
    @JsonProperty("firstName") var firstName: String? = null
    @JsonProperty("lastName") var lastName: String? = null
    @JsonProperty("location") var location: Location? = null
}

Location.kt


import com.fasterxml.jackson.annotation.*

open abstract class Location {
    @JsonProperty("type") var type: String? = null
}

Web.kt


import com.fasterxml.jackson.annotation.*

open class Web : Location {
    @JsonProperty("url") var url: String? = null
}

World.kt


import com.fasterxml.jackson.annotation.*

open class World : Location {
    @JsonProperty("lat") var lat: String? = null
    @JsonProperty("long") var long: String? = null
}

Model with generics

A struct which uses generics.

{
  "definitions": {
    "Student": {
      "type": "struct",
      "properties": {
        "matricleNumber": {
          "type": "integer"
        }
      }
    },
    "StudentMap": {
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "Map",
        "template": {
          "T": "Student"
        }
      }
    },
    "Map": {
      "type": "struct",
      "properties": {
        "totalResults": {
          "type": "integer"
        },
        "entries": {
          "type": "array",
          "schema": {
            "type": "generic",
            "name": "T"
          }
        }
      }
    }
  },
  "root": "StudentMap"
}

Student.kt


import com.fasterxml.jackson.annotation.*

open class Student {
    @JsonProperty("matricleNumber") var matricleNumber: Int? = null
}

Map.kt


import com.fasterxml.jackson.annotation.*

open class Map<T> {
    @JsonProperty("totalResults") var totalResults: Int? = null
    @JsonProperty("entries") var entries: ArrayList<T>? = null
}

StudentMap.kt


import com.fasterxml.jackson.annotation.*

open class StudentMap : Map<Student> {
}

Import other TypeSchema specification

A struct which references an external TypeSchema.

{
  "import": {
    "my_ns": "file:///generic.json"
  },
  "definitions": {
    "Faculty": {
      "type": "struct",
      "properties": {
        "description": {
          "type": "string"
        },
        "students": {
          "type": "array",
          "schema": {
            "type": "reference",
            "target": "my_ns:StudentMap"
          }
        }
      }
    }
  },
  "root": "Faculty"
}

Faculty.kt


import com.fasterxml.jackson.annotation.*

open class Faculty {
    @JsonProperty("description") var description: String? = null
    @JsonProperty("students") var students: ArrayList<StudentMap>? = null
}

Edit this page