org.coursera.courier.generator.specs

UnionDefinition

Related Doc: package specs

case class UnionDefinition(spec: UnionTemplateSpec) extends Definition with Product with Serializable

Union names are inferred from the containing type or typeref.

Note that all unions are defined anonymously, so pegasus makes a best effort to give them a reasonable name.

E.g. A union defined as the type of a field of a record will be named after that field.

Linear Supertypes
Serializable, Serializable, Product, Equals, Definition, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UnionDefinition
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Definition
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnionDefinition(spec: UnionTemplateSpec)

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def dataType: String

    The pegasus "data" type.

    The pegasus "data" type.

    This if sometimes the same as scalaType. It will be different for custom type and for primitive types.

    For custom types, it will be the referenced type.

    For primitives, this will be the java boxed type, e.g. java.lang.Integer whereas the scalaType would be Int.

    Definition Classes
    Definition
  7. def enclosingDefinition: Option[Definition]

    The containing type of this type, if any.

    The containing type of this type, if any.

    When a type is contained in another type, it should be generated as a subtype of that type.

    Unions are commonly generated as contained types.

    Definition Classes
    Definition
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  12. def memberName: String

    The name that should be given to any Union member wrappers of this type.

    The name that should be given to any Union member wrappers of this type.

    Definition Classes
    Definition
  13. def members: Seq[UnionMemberDefinition]

    The union member types.

  14. def namespace: Option[String]

    The namespace of the scala type, if any.

    The namespace of the scala type, if any.

    Only present for complex types.

    Definition Classes
    Definition
  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. def scalaDoc: Option[String]

    Includes the opening and closing scaladoc comment tags.

    Includes the opening and closing scaladoc comment tags.

    Definition Classes
    UnionDefinitionDefinition
  19. def scalaType: String

    The scala type without namespace.

    The scala type without namespace.

    For complex types, this is the name of the generated data binding class.

    For primitive types, this is the Scala native type, e.g. "Int".

    Definition Classes
    Definition
  20. def scalaTypeFullname: String

    The fully qualified name of the scala type.

    The fully qualified name of the scala type.

    Definition Classes
    Definition
  21. def schema: UnionDataSchema

    The schema of the type.

    The schema of the type.

    Definition Classes
    UnionDefinitionDefinition
  22. val spec: UnionTemplateSpec

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

    Definition Classes
    AnyRef
  24. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Definition

Inherited from AnyRef

Inherited from Any

Ungrouped