org.coursera.courier.generator.specs

RecordField

case class RecordField(field: Field) extends Deprecatable with 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, Deprecatable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RecordField
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Deprecatable
  7. AnyRef
  8. 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: 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 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.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

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

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

  10. def dataClass: 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".

  11. def default: Option[FieldDefault]

  12. 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
  13. 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.

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

    Definition Classes
    AnyRef
  15. val field: Field

  16. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  18. val isDefaultNone: Boolean

    Custom property supported by Courier.

    Custom property supported by Courier. If "defaultNone" is true for an optional value, it's default value in Scala will be None.

    This is useful in Scala, because Scala supports default values on parameters, allowing defaults to be provided by the generator to record type "constructors" (apply methods really).

  19. def isDeprecated: Boolean

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

    Definition Classes
    Any
  21. def isOptional: Boolean

  22. def name: String

    Escaped name for use in scala source.

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

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

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

    Definition Classes
    AnyRef
  26. def pegasusName: String

    Unescaped name.

  27. def properties: Map[String, AnyRef]

    Definition Classes
    RecordFieldDeprecatable
  28. def scalaDoc: Option[String]

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

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

  31. def schemaField: Field

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

    Definition Classes
    AnyRef
  33. def typ: Definition

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

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

  34. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. 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.

  38. 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 Deprecatable

Inherited from AnyRef

Inherited from Any

Ungrouped