ModelBuilder

Instance Constructors

new ModelBuilder(u: U)

u
The reflection universe. Can support macro and runtime reflection

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val IntrinsicType: List[Product with Serializable with SimpleType]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val helpers: ASTHelpers[u.type]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mkAnyWrapper(path: List[String], name: String): (U.Tree, List[U.Tree])

If there's no schema specified what do we do? It seems this leaves the json open to be anything.
If there's no schema specified what do we do? It seems this leaves the json open to be anything. The best we can do is make it an Any type, but to stop things getting too far out of control we wrap it in a type so that we can maintain some control over the encoding/decodng (and allow for customization).
path
The package path to where this is type is defined.
name
The name of the wrapper class.
def mkCaseClassDef(path: List[String], name: String, fields: List[Field], requiredFields: Option[List[String]]): (U.Tree, List[U.Tree])

Main workhorse.
Main workhorse. Creates case-classes from given fields.
def mkDef(path: List[String], name: String, schema: Root): (U.Tree, List[U.Tree])

Creates a Class/Type definition (i.e.
Creates a Class/Type definition (i.e. creates a case class or type alias).
name
The name of the class/type to that is created
def mkEnumDef(path: List[String], baseName: String, enum: List[String]): (U.Tree, List[U.Tree])

Makes a representation of an enumeration type.
Makes a representation of an enumeration type. We model this as a "sum type" in scala, where each enum is an object that inherits from the base trait. The base trait is sealed so that it can be used for pattern matching.
baseName
Name of the enum (becomes the name of the base trait)
enum
List of all possible enum values (encoded as a string containing their json representation)
returns
List[Tree] containing all the definitions
def mkIntrinsicType(st: SimpleType): U.Tree

Make a type from a SimpleType, when st is a built in type (i.e.
Make a type from a SimpleType, when st is a built in type (i.e. Boolean, Int, Double, String, or Null)
def mkSchemaDef(name: String, schema: Root, path: List[String] = Nil): (U.Tree, List[U.Tree])

Makes all definitions required to define the given schema
Makes all definitions required to define the given schema
name
The name of the root type that represents this schema
schema
The schema to generate from.
path
A package path for where this is defined. Defaults to Nil.
returns
A tuple containing the type of the root element that is generated, and all definitions required to support it
def mkType(path: List[String], schema: Root, defaultName: String): (U.Tree, List[U.Tree])

Extracts a type from the given Schema, using schema.typ or schema.$ref.
Extracts a type from the given Schema, using schema.typ or schema.$ref. Usually this means referencing an existing type, be it a $ref or an intrinsic type.
However since Schemas can contain nested anonymous types, sometimes as a side-effect we will also create new types (via mkDef()). In this case we name the anon type based on the given defaultName
returns
A tuple containing the Ident of the type, and a Tree of any addition class definitions that needed to be generated.
def mkTypeAlias(path: List[String], name: String, toType: U.Tree): (U.Tree, List[U.Tree])

Creates type alias definitions
Creates type alias definitions
returns
A tuple containing the created type, and a type alias definition
def mkUnionTypeDef(path: List[String], baseName: String, schemas: List[Root]): (U.Tree, List[U.Tree])

Json allows type disjunctions, that is: parameters that can take on instances of A OR B.
Json allows type disjunctions, that is: parameters that can take on instances of A OR B. This is modelled in scala using "sum types". Sum types wrap the allowed types (e.g. TypA(a: A), TypB(b: B)), and a common sealed base trait (e.g. Typ) to represent the union.
baseName
The name of the Union wrapper
schemas
A list of allowed sub-types
returns
A list of definitions created to support the union type.
def mkValDef(path: List[String], field: Field, optional: Boolean): (U.ValDef, List[U.Tree])

Makes a value definition (e.g.
Makes a value definition (e.g. val i: Int). These are used for constructing parameter lists and declaring local objects
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
val u: U

The reflection universe.
The reflection universe. Can support macro and runtime reflection
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package macros

class ModelBuilder[U <: Universe] extends AnyRef

Instance Constructors

new ModelBuilder(u: U)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val IntrinsicType: List[Product with Serializable with SimpleType]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val helpers: ASTHelpers[u.type]

final def isInstanceOf[T0]: Boolean

def mkAnyWrapper(path: List[String], name: String): (U.Tree, List[U.Tree])

def mkCaseClassDef(path: List[String], name: String, fields: List[Field], requiredFields: Option[List[String]]): (U.Tree, List[U.Tree])

def mkDef(path: List[String], name: String, schema: Root): (U.Tree, List[U.Tree])

def mkEnumDef(path: List[String], baseName: String, enum: List[String]): (U.Tree, List[U.Tree])

def mkIntrinsicType(st: SimpleType): U.Tree

def mkSchemaDef(name: String, schema: Root, path: List[String] = Nil): (U.Tree, List[U.Tree])

def mkType(path: List[String], schema: Root, defaultName: String): (U.Tree, List[U.Tree])

def mkTypeAlias(path: List[String], name: String, toType: U.Tree): (U.Tree, List[U.Tree])

def mkUnionTypeDef(path: List[String], baseName: String, schemas: List[Root]): (U.Tree, List[U.Tree])

def mkValDef(path: List[String], field: Field, optional: Boolean): (U.ValDef, List[U.Tree])

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

val u: U

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped