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

   @native() @throws( ... )

7.  def customInfo: Option[CustomInfoDefinition]

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

8.  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".

9.  def default: Option[FieldDefault]
10.  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

11.  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.

12.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

13.  val explicit: Boolean

    Custom property supported by Courier.

    Custom property supported by Courier. If "explicit" is true for an optional value, it will not be defaulted to None in generated data bindings.

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

14.  val field: Field
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

    Annotations

    @native()

17.  def isDeprecated: Boolean

    Definition Classes

    Deprecatable

18.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

19.  def isOptional: Boolean
20.  def name: String

    Escaped name for use in scala source.

21.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

22.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

23.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

24.  def omit: Boolean
25.  def pegasusName: String

    Unescaped name.

26.  def properties: Map[String, AnyRef]

    Definition Classes

    RecordField → Deprecatable

27.  def scalaDoc: Option[String]
28.  def scalaProperties: Option[DataMap]
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, ...).

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

    @native() @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.