org.coursera.courier.generator.specs

MaybeBoxable

trait MaybeBoxable extends Definition

Convenience trait for primitive types since they sometimes need to be boxed/unboxed.

Linear Supertypes
Definition, Deprecatable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MaybeBoxable
  2. Definition
  3. Deprecatable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def directReferencedTypes: Set[Definition]

    Return types this type references.

    Return types this type references. For a record, this will return the types of all the fields. For a array, this will return the items type.

    Definition Classes
    Definition
  2. abstract def rawDataType: String

    The raw pegasus "data" type that is stored in the underlying DataMap or DataList.

    The raw pegasus "data" type that is stored in the underlying DataMap or DataList.

    For custom types, this is the raw type of fully dereferenced type.

    For primitives, this is the java boxed type, e.g. java.lang.Integer.

    For complex types, this is the raw, type, e.g. DataMap for records, DataList for arrays.

    Definition Classes
    Definition
  3. abstract def scalaDoc: Option[String]

    Includes the opening and closing scaladoc comment tags.

    Includes the opening and closing scaladoc comment tags.

    Definition Classes
    Definition
  4. abstract def schema: Option[DataSchema]

    The schema of the type.

    The schema of the type. Not present for definitions of "raw" classes, such as the 'coercer' and 'class' of a custom type.

    Definition Classes
    Definition

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. def allReferencedTypes: Set[Definition]

    Return all types directly or transitively referenced by this type.

    Return all types directly or transitively referenced by this type.

    Definition Classes
    Definition
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def containedTypes: Set[Definition]

    All types that should be generated as types inside this type.

    All types that should be generated as types inside this type.

    Definition Classes
    Definition
  10. 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
  11. def deprecationMessage: Option[String]

    Is is possible for a type to be deprecated but have not deprecation message, so even if this is None, isDeprecated still might be true.

    Is is possible for a type to be deprecated but have not deprecation message, so even if this is None, isDeprecated still might be true.

    Definition Classes
    Deprecatable
  12. 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
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(other: Any): Boolean

    Definition Classes
    Definition → AnyRef → Any
  15. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Definition Classes
    Definition → AnyRef → Any
  18. def isDeprecated: Boolean

    Definition Classes
    Deprecatable
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. def isTopLevel: Boolean

    Definition Classes
    Definition
  21. def maybeBox(expr: Txt): Txt

  22. def maybeUnbox(expr: Txt): Txt

    If this definition requires boxing, return a Scala expression that boxes the given Scala expression.

    If this definition requires boxing, return a Scala expression that boxes the given Scala expression.

    The given Scala expression must return AnyVal (and hence, must not evaluate to null).

  23. 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
  24. 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
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  28. def properties: Map[String, AnyRef]

    Definition Classes
    DefinitionDeprecatable
  29. def requiresBoxing: Boolean

  30. def scalaGenericCollectionType: String

    The scala Generic collection type that corresponds to the type.

    The scala Generic collection type that corresponds to the type. This is the same as scalaTypeFullname for all types except maps and arrays, which are represented by Map[K, V] and Traversable[I] instead of by their pegasus generated binding types.

    Definition Classes
    Definition
  31. 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
  32. def scalaTypeFullname: String

    The fully qualified name of the scala type.

    The fully qualified name of the scala type.

    Definition Classes
    Definition
  33. val spec: ClassTemplateSpec

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

    Definition Classes
    AnyRef
  35. def toString(): String

    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Definition

Inherited from Deprecatable

Inherited from AnyRef

Inherited from Any

Ungrouped