UnionWithTyperefCompanion

Identifies companion objects of the Scala union "template" classes generated by Courier that were defined within a typeref and provides access to the typeref's schema.

Because the union is not a named type in Pegasus, it cannot have schema properties directly defied on it. As a result, the defining typeref is often used as an anchor for adding names and properties to unions.

For example, in:

Linear Supertypes

UnionCompanion[K], SchemaAware, AnyRef, Any

Abstract Value Members

abstract def SCHEMA: UnionDataSchema

returns
the data schema for the corresponding Courier type.

Definition Classes
UnionCompanion → SchemaAware
abstract def TYPEREF_SCHEMA: TyperefDataSchema

returns
the schema of the typeref that was used to define this union.
abstract def build(dataMap: DataMap, conversion: DataConversion): K

Definition Classes
UnionCompanion

Concrete 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
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
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 companions

trait UnionWithTyperefCompanion[K <: ScalaUnionTemplate] extends UnionCompanion[K]

Abstract Value Members

abstract def SCHEMA: UnionDataSchema

abstract def TYPEREF_SCHEMA: TyperefDataSchema

abstract def build(dataMap: DataMap, conversion: DataConversion): K

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

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

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from UnionCompanion[K]

Inherited from SchemaAware

Inherited from AnyRef

Inherited from Any

Ungrouped