org.coursera.courier.generator.specs
Definition
Related Docs:
object Definition
| package specs
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.
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.
Includes the opening and closing scaladoc comment tags.
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.
Return all types directly or transitively referenced by this type.
All types that should be generated as types inside this type.
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.
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.
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.
The name that should be given to any Union member wrappers of this type.
The namespace of the scala type, if any.
The namespace of the scala type, if any.
Only present for complex types.
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.
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".
The fully qualified name of the scala type.
Pegasus provides
ClassTemplateSpecs to "flatten" the data schemas provided to a data binding generator and make it easier to write the generator.These Definitions classes wrap
ClassTemplateSpecs so that we can use idiomatic scala types in our templates. They also add language specific escaping and convenience functions specifically for generating data bindings for Scala.This trait is for all Scala classes that wrap ClassTemplateSpec and it's sub-classes, it represents the common properties shared by all pegasus data binding generator utility types.