org.coursera.courier.generator.specs

RecordField

Related Doc: package specs

case class RecordField(field: Field) extends Product with Serializable

The field of a record, may be either a field directly defined in the record or an "include" field.

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

Instance Constructors

  1. new RecordField(field: Field)

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. def applyIfOption(ref: String)(f: (String) ⇒ Txt): Txt

    If this field is optional, apply the expression in a foreach body to the ref, else apply it directly to the ref.

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def customInfo: Option[CustomInfoDefinition]

    Present only if the type of a field is a custom type.

  8. def dataClass: Option[Definition]

    The pegasus data type of the field.

    The pegasus data type of the field.

    For the put and obtain methods in RecordTemplate (be it direct, wrapped or customType), this is the type that RecordTemplate expects for the "dataClass".

  9. def default: AnyRef

  10. def enclosingClass: Option[Definition]

    If the field type is enclosed in another type, the enclosing class.

    If the field type is enclosed in another type, the enclosing class.

    When generating classes, if the enclosing type is the current type being generated, then the type of this field should be generated as a subclass.

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. val field: Field

  13. def finalize(): Unit

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

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

    Definition Classes
    Any
  16. def isOptional: Boolean

  17. def name: String

    Escaped name for use in scala source.

  18. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  21. def pegasusName: String

    Unescaped name.

  22. def scalaDoc: Option[String]

  23. def scalaType: String

    Fields are aware of optionality, so the scalaType of a field type can be wrapped with Option[] if it is an optional field.

  24. def scalaTypeFullname: String

    Fields are aware of optionality, so the fully qualified name of a field type can be wrapped with Option[] if it is an optional field.

  25. def schemaField: Field

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

    Definition Classes
    AnyRef
  27. def typ: Definition

    The type definition of the field, may be any pegasus type (record, primitive, enum, union, ...).

  28. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def wrapAndMapIfOption(ref: Txt)(f: (Txt) ⇒ Txt): Txt

    If this field is optional, wrap the provided ref expression with Option(ref) and then map the option with the provided f function.

  32. def wrapIfOption(expr: Txt): Txt

    If this field is optional, wrap the provided expression with Option(expr), else return the expression.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped