com.twitter.scrooge.backend

TemplateGenerator

trait 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. ThriftGenerator
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

    Definition Classes
    StructTemplate

Abstract Value Members

  1. abstract val defaultNamespace: String

    Definition Classes
    Generator
  2. abstract val experimentFlags: Seq[String]

    Definition Classes
    Generator
  3. abstract def fileExtension: String

  4. abstract def genBaseFinagleService: CodeFragment

    Definition Classes
    Generator
  5. abstract def genEnum(enum: EnumRHS, fieldType: Option[FieldType] = None): CodeFragment

    Definition Classes
    Generator
  6. abstract def genFieldParams(fields: Seq[Field], asVal: Boolean = false): CodeFragment

    Definition Classes
    Generator
  7. abstract def genFieldType(f: Field, mutable: Boolean = false): CodeFragment

    Definition Classes
    Generator
  8. abstract def genList(list: ListRHS, mutable: Boolean = false): CodeFragment

    Definition Classes
    Generator
  9. abstract def genMap(map: MapRHS, mutable: Boolean = false): CodeFragment

    Definition Classes
    Generator
  10. abstract def genPrimitiveType(t: FunctionType, mutable: Boolean = false): CodeFragment

    Definition Classes
    Generator
  11. abstract def genSet(set: SetRHS, mutable: Boolean = false, fieldType: Option[FieldType] = None): CodeFragment

    Definition Classes
    Generator
  12. abstract def genStruct(struct: StructRHS): CodeFragment

    Definition Classes
    Generator
  13. abstract def genToImmutable(f: Field): CodeFragment

    Generates a suffix to append to a field expression that will convert the value to an immutable equivalent.

    Generates a suffix to append to a field expression that will convert the value to an immutable equivalent.

    Definition Classes
    Generator
  14. abstract def genToImmutable(t: FieldType): CodeFragment

    Generates a suffix to append to a field expression that will convert the value to an immutable equivalent.

    Generates a suffix to append to a field expression that will convert the value to an immutable equivalent.

    Definition Classes
    Generator
  15. abstract def genType(t: FunctionType, mutable: Boolean = false): CodeFragment

    Definition Classes
    Generator
  16. abstract def getParentFinagleClient(parent: ServiceParent): CodeFragment

    Definition Classes
    Generator
  17. abstract def getParentFinagleService(parent: ServiceParent): CodeFragment

    Definition Classes
    Generator
  18. abstract val includeMap: Map[String, ResolvedDocument]

    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
    Generator
  19. abstract def normalizeCase[N <: Node](node: N): N

    Definition Classes
    Generator
  20. abstract def quoteKeyword(str: String): String

    Definition Classes
    Generator
  21. abstract def templates: HandlebarLoader

  22. abstract def toMutable(f: Field): (String, String)

    Generates a prefix and suffix to wrap around a field expression that will convert the value to a mutable equivalent.

    Generates a prefix and suffix to wrap around a field expression that will convert the value to a mutable equivalent.

    Definition Classes
    Generator
  23. abstract def toMutable(t: FieldType): (String, String)

    Generates a prefix and suffix to wrap around a field expression that will convert the value to a mutable equivalent.

    Generates a prefix and suffix to wrap around a field expression that will convert the value to a mutable equivalent.

    Definition Classes
    Generator

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

    Definition Classes
    StructTemplate
  7. def apply(_doc: Document, serviceOptions: Set[ServiceOption], outputPath: File, dryRun: Boolean = false): Iterable[File]

    Definition Classes
    TemplateGeneratorThriftGenerator
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. val basePassthrough: Dictionary

    Definition Classes
    StructTemplate
  10. def clone(): AnyRef

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

    Definition Classes
    ConstsTemplate
  12. def enumDict(namespace: Identifier, enum: Enum): Dictionary

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

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

    Definition Classes
    AnyRef → Any
  15. def fieldsToDict(fields: Seq[Field], blacklist: Seq[String]): Seq[Dictionary]

    Definition Classes
    StructTemplate
  16. def finagleClient(service: Service, namespace: Identifier): Dictionary

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

    Definition Classes
    Generator
  18. def finagleService(service: Service, namespace: Identifier): Dictionary

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

    Definition Classes
    Generator
  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def genConstType(t: FunctionType): CodeFragment

    Definition Classes
    Generator
  22. def genConstant(constant: RHS, mutable: Boolean = false, fieldType: Option[FieldType] = None): CodeFragment

    Definition Classes
    Generator
  23. def genDefaultFieldValue(f: Field): Option[CodeFragment]

    Definition Classes
    Generator
  24. def genDefaultReadValue(f: Field): CodeFragment

    Definition Classes
    Generator
  25. def genDefaultValue(fieldType: FieldType, mutable: Boolean = false): CodeFragment

    The default value for the specified type and mutability.

    The default value for the specified type and mutability.

    Definition Classes
    Generator
  26. def genID(data: Identifier): CodeFragment

    Definition Classes
    Generator
  27. def genProtocolReadMethod(t: FunctionType): CodeFragment

    Definition Classes
    Generator
  28. def genProtocolWriteMethod(t: FunctionType): CodeFragment

    Definition Classes
    Generator
  29. def genWireConstType(t: FunctionType): CodeFragment

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

    Definition Classes
    AnyRef → Any
  31. def getIncludeNamespace(includeFileName: String): Identifier

    Attributes
    protected
    Definition Classes
    Generator
  32. def getNamespace(doc: Document): Identifier

    Definition Classes
    Generator
  33. def getServiceParentID(parent: ServiceParent): Identifier

    get the ID of a service parent.

    get the ID of a service parent. Java and Scala implementations are different.

    Definition Classes
    Generator
  34. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  35. def internalArgsStruct(f: Function): FunctionArgs

    Definition Classes
    ServiceTemplate
  36. def internalArgsStructName(f: Function): SimpleID

    Definition Classes
    ServiceTemplate
  37. def internalArgsStructNameForWire(f: Function): String

    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
  38. def internalResultStruct(f: Function): FunctionResult

    Definition Classes
    ServiceTemplate
  39. def internalResultStructName(f: Function): SimpleID

    Definition Classes
    ServiceTemplate
  40. def internalResultStructNameForWire(f: Function): String

    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
  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  42. def isNullableType(t: FieldType, isOptional: Boolean = false): Boolean

    Definition Classes
    Generator
  43. def isPrimitive(t: FunctionType): Boolean

    Definition Classes
    Generator
  44. def namespacedFolder(destFolder: File, namespace: String, dryRun: Boolean): File

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

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

    Attributes
    protected
    Definition Classes
    Generator
  45. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  48. def qualifyNamedType(t: NamedType): Identifier

    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
    Generator
  49. def quote(str: String): String

    Definition Classes
    Generator
  50. def readWriteInfo[T <: FieldType](sid: SimpleID, t: FieldType): Dictionary

    Definition Classes
    StructTemplate
  51. def serviceDict(service: Service, namespace: Identifier, includes: Seq[Include], options: Set[ServiceOption]): Dictionary

    Definition Classes
    ServiceTemplate
  52. def structDict(struct: StructLike, namespace: Option[Identifier], includes: Seq[Include], serviceOptions: Set[ServiceOption]): Dictionary

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

    Definition Classes
    AnyRef
  54. def toDictionary(function: Function, generic: Option[String]): Dictionary

    Definition Classes
    ServiceTemplate
  55. def toString(): String

    Definition Classes
    AnyRef → Any
  56. final def wait(): Unit

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

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

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

    Attributes
    protected
    Definition Classes
    Generator

Inherited from EnumTemplate

Inherited from ConstsTemplate

Inherited from ServiceTemplate

Inherited from StructTemplate

Inherited from Generator

Inherited from ThriftGenerator

Inherited from AnyRef

Inherited from Any

Ungrouped