Class/Object

com.twitter.scrooge.backend

TemplateGenerator

Related Docs: object TemplateGenerator | package backend

Permalink

abstract class TemplateGenerator extends Generator with StructTemplate with ServiceTemplate with ConstsTemplate with EnumTemplate

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

Instance Constructors

  1. new TemplateGenerator(resolvedDoc: ResolvedDocument)

    Permalink

Type Members

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

    Permalink
    Definition Classes
    StructTemplate

Abstract Value Members

  1. abstract val defaultNamespace: String

    Permalink

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

  2. abstract def fileExtension: String

    Permalink
  3. abstract def genBaseFinagleService: CodeFragment

    Permalink
  4. abstract def genEnum(enum: EnumRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
  5. abstract def genFieldParams(fields: Seq[Field], asVal: Boolean = false): CodeFragment

    Permalink
  6. abstract def genFieldType(f: Field): CodeFragment

    Permalink
  7. abstract def genList(list: ListRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
  8. abstract def genMap(map: MapRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
  9. abstract def genPrimitiveType(t: FunctionType): CodeFragment

    Permalink
  10. abstract def genSet(set: SetRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
  11. abstract def genStruct(struct: StructRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
  12. abstract def genType(t: FunctionType, immutable: Boolean = false): CodeFragment

    Permalink
  13. abstract def genUnion(union: UnionRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
  14. abstract def getParentFinagleClient(parent: ServiceParent): CodeFragment

    Permalink
  15. abstract def getParentFinagleService(parent: ServiceParent): CodeFragment

    Permalink
  16. abstract val languageFlags: Seq[String]

    Permalink
  17. abstract def 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
    Generator
  18. abstract def quoteKeyword(str: String): String

    Permalink
  19. abstract def templates: HandlebarLoader

    Permalink

Concrete 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. def enumDict(namespace: Identifier, enum: Enum): Dictionary

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def fieldsToDict(fields: Seq[Field], blacklist: Seq[String], namespace: Option[Identifier] = None): Seq[Dictionary]

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

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

    Permalink
  16. def finagleService(service: Service, namespace: Identifier): Dictionary

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

    Permalink
  18. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    ServiceTemplate
  22. def genConstType(t: FunctionType): CodeFragment

    Permalink
  23. def genConstant(constant: RHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
  24. def genDecodeProtocolMethod(t: FunctionType): CodeFragment

    Permalink
  25. 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.

  26. def genDefaultFieldValueForFieldInfo(f: Field): Option[CodeFragment]

    Permalink
  27. def genDefaultReadValue(f: Field): CodeFragment

    Permalink
  28. def genDefaultValue(fieldType: FieldType): CodeFragment

    Permalink

    The default value for the specified type and mutability.

  29. def genID(data: Identifier): CodeFragment

    Permalink
  30. def genOffsetSkipProtocolMethod(t: FunctionType): CodeFragment

    Permalink
  31. def genProtocolReadMethod(t: FunctionType): CodeFragment

    Permalink
  32. def genProtocolSkipMethod(t: FunctionType): CodeFragment

    Permalink
  33. def genProtocolWriteMethod(t: FunctionType): CodeFragment

    Permalink
  34. def genQualifiedID(id: Identifier, namespace: Identifier): CodeFragment

    Permalink
  35. def genUnsafeEmptyReadValue(f: Field): CodeFragment

    Permalink
  36. def genUnsafeEmptyValue(fieldType: FieldType): CodeFragment

    Permalink

    The default value for the unsafe empty value case.

    The default value for the unsafe empty value case. These predefined values will be used to create field blob. For String, null is not valid value for required field.

  37. def genWireConstType(t: FunctionType): CodeFragment

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

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

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

    Permalink
    Attributes
    protected
  41. def getNamespace(doc: Document): Identifier

    Permalink
  42. def getServiceParentID(parent: ServiceParent): Identifier

    Permalink
  43. def getSuccessType(result: FunctionResult): CodeFragment

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

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

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

    Permalink
    Definition Classes
    Generator
  47. 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
  48. final def isInstanceOf[T0]: Boolean

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

    Permalink
  50. def isNullableType(t: FieldType, isOptional: Boolean = false): Boolean

    Permalink
  51. def isPrimitive(t: FunctionType): Boolean

    Permalink
  52. def namespacedFolder(destFolder: File, namespace: String, dryRun: Boolean): File

    Permalink

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

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

    Attributes
    protected
  53. final def ne(arg0: AnyRef): Boolean

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

    Permalink
  55. final def notify(): Unit

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

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

    Permalink

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

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

  59. def quote(str: String): String

    Permalink
  60. def readWriteInfo[T <: FieldType](sid: SimpleID, t: FieldType): Dictionary

    Permalink
    Definition Classes
    StructTemplate
  61. val resolvedDoc: ResolvedDocument

    Permalink
  62. 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
  63. def serviceDict(service: Service, namespace: Identifier, includes: Seq[Include], options: Set[ServiceOption], genAdapt: Boolean): Dictionary

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

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

    Permalink
    Definition Classes
    AnyRef
  66. def toString(): String

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

    Permalink

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

  68. def unwrapArgs(arity: Int): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. def writeFile(file: File, fileHeader: String, fileContent: String): Unit

    Permalink
    Attributes
    protected

Inherited from EnumTemplate

Inherited from ConstsTemplate

Inherited from ServiceTemplate

Inherited from StructTemplate

Inherited from Generator

Inherited from AnyRef

Inherited from Any

Ungrouped