Class

com.twitter.scrooge.backend

ScalaGenerator

Related Doc: package backend

Permalink

class ScalaGenerator extends TemplateGenerator

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaGenerator
  2. TemplateGenerator
  3. EnumTemplate
  4. ConstsTemplate
  5. ServiceTemplate
  6. StructTemplate
  7. Generator
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaGenerator(resolvedDoc: ResolvedDocument, defaultNamespace: String, experimentFlags: Seq[String], templatesLoader: HandlebarLoader)

    Permalink

Type Members

  1. case class Binding[FT <: FieldType](name: String, fieldType: FT) extends Product with Serializable

    Permalink
    Definition Classes
    StructTemplate

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. val TypeTemplate: Dictionary

    Permalink
    Definition Classes
    StructTemplate
  5. def apply(serviceOptions: Set[ServiceOption], outputPath: File, dryRun: Boolean = false, genAdapt: Boolean = false): Iterable[File]

    Permalink

    genAdapt

    Generate code for Adaptive Decoding. This flag is only used for scala presently.

    Definition Classes
    TemplateGeneratorGenerator
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val basePassthrough: Dictionary

    Permalink
    Definition Classes
    StructTemplate
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def constDict(namespace: Identifier, consts: Seq[ConstDefinition]): Dictionary

    Permalink
    Definition Classes
    ConstsTemplate
  10. val defaultNamespace: String

    Permalink

    Map from included file names to the namespaces defined in those files.

    Map from included file names to the namespaces defined in those files.

    Definition Classes
    ScalaGeneratorTemplateGenerator
  11. def enumDict(namespace: Identifier, enum: Enum): Dictionary

    Permalink
    Definition Classes
    EnumTemplate
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. val experimentFlags: Seq[String]

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  15. def fieldsToDict(fields: Seq[Field], blacklist: Seq[String], namespace: Option[Identifier] = None): Seq[Dictionary]

    Permalink
    Definition Classes
    StructTemplate
  16. val fileExtension: String

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  17. def finagleClient(service: Service, namespace: Identifier, withAsClosable: Boolean): Dictionary

    Permalink
    Definition Classes
    ServiceTemplate
  18. def finagleClientFile(packageDir: File, service: Service, options: Set[ServiceOption]): Option[File]

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  19. def finagleService(service: Service, namespace: Identifier): Dictionary

    Permalink
    Definition Classes
    ServiceTemplate
  20. def finagleServiceFile(packageDir: File, service: Service, options: Set[ServiceOption]): Option[File]

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def functionArgsStruct(f: Function): FunctionArgs

    Permalink
    Definition Classes
    ServiceTemplate
  23. def functionDictionary(function: Function, generic: Option[String]): Dictionary

    Permalink
    Definition Classes
    ServiceTemplate
  24. def functionObjectName(f: Function): SimpleID

    Permalink
    Definition Classes
    ServiceTemplate
  25. def genBaseFinagleService: CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  26. def genConstType(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  27. def genConstant(constant: RHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  28. def genDecodeProtocolMethod(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  29. def genDefaultFieldValue(f: Field, forAlternateConstructor: Boolean = false): Option[CodeFragment]

    Permalink

    Creates a code fragment for the default value of the field.

    Creates a code fragment for the default value of the field.

    f

    field to generate the default value for.

    forAlternateConstructor

    Whether this is for the alternate Immutable constructor which does not take an Option for construction required fields.

    Definition Classes
    TemplateGenerator
  30. def genDefaultFieldValueForFieldInfo(f: Field): Option[CodeFragment]

    Permalink
    Definition Classes
    TemplateGenerator
  31. def genDefaultReadValue(f: Field): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  32. def genDefaultValue(fieldType: FieldType): CodeFragment

    Permalink

    The default value for the specified type and mutability.

    The default value for the specified type and mutability.

    Definition Classes
    ScalaGeneratorTemplateGenerator
  33. def genEnum(enum: EnumRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  34. def genFieldParams(fields: Seq[Field], asVal: Boolean = false): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  35. def genFieldType(f: Field): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  36. def genID(data: Identifier): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  37. def genList(list: ListRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  38. def genMap(map: MapRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  39. def genOffsetSkipProtocolMethod(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  40. def genPrimitiveType(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  41. def genProtocolReadMethod(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  42. def genProtocolSkipMethod(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  43. def genProtocolWriteMethod(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  44. def genQualifiedID(id: Identifier, namespace: Identifier): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  45. def genSet(set: SetRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  46. def genStruct(struct: StructRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  47. def genType(t: FunctionType, immutable: Boolean = false): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  48. def genUnion(union: UnionRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  49. def genWireConstType(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    StructTemplate
  50. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  51. def getExceptionFields(result: FunctionResult): CodeFragment

    Permalink
    Definition Classes
    StructTemplate
  52. def getIncludeNamespace(includeFileName: String): Identifier

    Permalink
    Attributes
    protected
    Definition Classes
    ScalaGeneratorTemplateGenerator
  53. def getNamespace(doc: Document): Identifier

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  54. def getParentFinagleClient(p: ServiceParent): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  55. def getParentFinagleService(p: ServiceParent): CodeFragment

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  56. def getServiceParentID(parent: ServiceParent): Identifier

    Permalink
    Definition Classes
    TemplateGenerator
  57. def getSuccessType(result: FunctionResult): CodeFragment

    Permalink
    Definition Classes
    StructTemplate
  58. def getSuccessValue(result: FunctionResult): CodeFragment

    Permalink
    Definition Classes
    StructTemplate
  59. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  60. def includeMap: Map[String, ResolvedDocument]

    Permalink
    Definition Classes
    Generator
  61. def internalArgsStructNameForWire(f: Function): String

    Permalink

    The name used in RPC request, this needs to be same as Apache compiler

    The name used in RPC request, this needs to be same as Apache compiler

    Definition Classes
    ServiceTemplate
  62. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  63. def isLazyReadEnabled(t: FunctionType, optional: Boolean): Boolean

    Permalink
    Definition Classes
    TemplateGenerator
  64. def isNullableType(t: FieldType, isOptional: Boolean = false): Boolean

    Permalink
    Definition Classes
    TemplateGenerator
  65. def isPrimitive(t: FunctionType): Boolean

    Permalink
    Definition Classes
    TemplateGenerator
  66. val namespaceLanguage: String

    Permalink

    Used to find the namespace in included files.

    Used to find the namespace in included files. This does not need to match the corresponding GeneratorFactory.language.

    Definition Classes
    ScalaGeneratorGenerator
  67. def namespacedFolder(destFolder: File, namespace: String, dryRun: Boolean): File

    Permalink

    ****************** helper functions ***********************

    ****************** helper functions ***********************

    Attributes
    protected
    Definition Classes
    TemplateGenerator
  68. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  69. def normalizeCase[N <: Node](node: N): N

    Permalink
    Definition Classes
    TemplateGenerator
  70. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  72. def productN(fields: Seq[Field], namespace: Option[Identifier]): String

    Permalink

    Returns a String "_root_.scala.Product${N}[Type1, Type2, ...]" or "scala.Product".

    Returns a String "_root_.scala.Product${N}[Type1, Type2, ...]" or "scala.Product".

    Definition Classes
    TemplateGenerator
  73. def qualifyNamedType(t: NamedType, namespace: Option[Identifier] = None): Identifier

    Permalink

    When a named type is imported via include statement, we need to qualify it using its full namespace

    When a named type is imported via include statement, we need to qualify it using its full namespace

    Definition Classes
    TemplateGenerator
  74. def quote(str: String): String

    Permalink
    Definition Classes
    TemplateGenerator
  75. def quoteKeyword(str: String): String

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  76. def readWriteInfo[T <: FieldType](sid: SimpleID, t: FieldType): Dictionary

    Permalink
    Definition Classes
    StructTemplate
  77. val resolvedDoc: ResolvedDocument

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  78. def resultStruct(f: Function): FunctionResult

    Permalink

    Thrift Result struct that includes success or exceptions returned.

    Thrift Result struct that includes success or exceptions returned.

    Definition Classes
    ServiceTemplate
  79. def serviceDict(service: Service, namespace: Identifier, includes: Seq[Include], options: Set[ServiceOption], genAdapt: Boolean): Dictionary

    Permalink
    Definition Classes
    ServiceTemplate
  80. def structDict(struct: StructLike, namespace: Option[Identifier], includes: Seq[Include], serviceOptions: Set[ServiceOption], genAdapt: Boolean, toplevel: Boolean = false): Dictionary

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

    Permalink
    Definition Classes
    AnyRef
  82. def templates: HandlebarLoader

    Permalink
    Definition Classes
    ScalaGeneratorTemplateGenerator
  83. val templatesLoader: HandlebarLoader

    Permalink
  84. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  85. def tupleN(fields: Seq[Field], namespace: Option[Identifier]): String

    Permalink

    Returns a String "_root_.scala.Tuple${N}[Type1, Type2, ...]"

    Returns a String "_root_.scala.Tuple${N}[Type1, Type2, ...]"

    Definition Classes
    TemplateGenerator
  86. def unwrapArgs(arity: Int): String

    Permalink
    Definition Classes
    ServiceTemplate
  87. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. var warnOnJavaNamespaceFallback: Boolean

    Permalink
  91. def writeFile(file: File, fileHeader: String, fileContent: String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    TemplateGenerator

Inherited from TemplateGenerator

Inherited from EnumTemplate

Inherited from ConstsTemplate

Inherited from ServiceTemplate

Inherited from StructTemplate

Inherited from Generator

Inherited from AnyRef

Inherited from Any

Ungrouped