Trait

org.coursera.courier.generator.specs

MaybeBoxable

Related Doc: package specs

Permalink

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
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def directReferencedTypes: Set[Definition]

    Permalink

    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

    Permalink

    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]

    Permalink

    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]

    Permalink

    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: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def allReferencedTypes: Set[Definition]

    Permalink

    Return all types directly or transitively referenced by this type.

    Return all types directly or transitively referenced by this type.

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

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

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

    Permalink

    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
  8. def dataType: String

    Permalink

    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
  9. def deprecationMessage: Option[String]

    Permalink

    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
  10. def enclosingDefinition: Option[Definition]

    Permalink

    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
  11. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    Definition → AnyRef → Any
  16. def isDeprecated: Boolean

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

    Permalink
    Definition Classes
    Any
  18. def isTopLevel: Boolean

    Permalink
    Definition Classes
    Definition
  19. def maybeBox(expr: Txt): Txt

    Permalink
  20. def maybeUnbox(expr: Txt): Txt

    Permalink

    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).

  21. def memberName: String

    Permalink

    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
  22. def namespace: Option[String]

    Permalink

    The namespace of the scala type, if any.

    The namespace of the scala type, if any.

    Only present for complex types.

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

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    DefinitionDeprecatable
  27. def requiresBoxing: Boolean

    Permalink
  28. def scalaGenericCollectionType: String

    Permalink

    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
  29. def scalaType: String

    Permalink

    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
  30. def scalaTypeFullname: String

    Permalink

    The fully qualified name of the scala type.

    The fully qualified name of the scala type.

    Definition Classes
    Definition
  31. val spec: ClassTemplateSpec

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

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Definition

Inherited from Deprecatable

Inherited from AnyRef

Inherited from Any

Ungrouped