case class Schema[T](schemaType: SchemaType, isOptional: Boolean = false, description: Option[String] = None, format: Option[String] = None, deprecated: Boolean = false) extends Product with Serializable

Describes the shape of the low-level, "raw" representation of type T.

format

The name of the format of the low-level representation of T.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Schema
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Schema(schemaType: SchemaType, isOptional: Boolean = false, description: Option[String] = None, format: Option[String] = None, deprecated: Boolean = false)

    format

    The name of the format of the low-level representation of T.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def asArrayElement[U]: Schema[U]

    Returns a collection version of this schema, with the schema type wrapped in SArray.

    Returns a collection version of this schema, with the schema type wrapped in SArray. Also, sets isOptional to true as the collection might be empty. Also, sets 'format' to None. Formats are only applicable to the array elements, not to the array as a whole.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asOptional[U]: Schema[U]

    Returns an optional version of this schema, with isOptional set to true.

  7. def asRequired[U]: Schema[U]

    Returns a required version of this schema, with isOptional set to false.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def deprecated(d: Boolean): Schema[T]
  10. val deprecated: Boolean
  11. def description(d: String): Schema[T]
  12. val description: Option[String]
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def format(f: String): Schema[T]
  16. val format: Option[String]
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val isOptional: Boolean
  20. macro def modify[U](path: (T) => U)(modification: (Schema[U]) => Schema[U]): Schema[T]
  21. def modifyUnsafe[U](fields: String*)(modify: (Schema[U]) => Schema[U]): Schema[T]
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val schemaType: SchemaType
  27. macro def setDescription[U](path: (T) => U, description: String): Schema[T]
  28. def show: String
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped