Class

com.twitter.scrooge.backend

CocoaGenerator

Related Doc: package backend

Permalink

class CocoaGenerator extends TemplateGenerator

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CocoaGenerator
  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 CocoaGenerator(doc: ResolvedDocument, defaultNamespace: String, headerTemplateLoader: HandlebarLoader, implementationTemplateLoader: HandlebarLoader)

    Permalink

Type Members

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

    Permalink
    Definition Classes
    StructTemplate
  2. implicit class RichDictionary extends AnyRef

    Permalink

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
    CocoaGeneratorTemplateGeneratorGenerator
  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. var currentNamespace: String

    Permalink
  11. 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
    CocoaGeneratorTemplateGenerator
  12. val doc: ResolvedDocument

    Permalink
  13. def enumDict(namespace: Identifier, enum: Enum): Dictionary

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

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

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

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

    Permalink
    Definition Classes
    CocoaGeneratorStructTemplate
  18. val fileExtension: String

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

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

    Permalink
    Definition Classes
    TemplateGenerator
  21. def finagleService(service: Service, namespace: Identifier): Dictionary

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

    Permalink
    Definition Classes
    TemplateGenerator
  23. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    ServiceTemplate
  27. def genBaseFinagleService: Nothing

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  28. def genConstType(t: FunctionType): CodeFragment

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

    Permalink
    Definition Classes
    TemplateGenerator
  30. def genDecodeProtocolMethod(t: FunctionType): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  31. 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
  32. def genDefaultFieldValueForFieldInfo(f: Field): Option[CodeFragment]

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

    Permalink
    Definition Classes
    TemplateGenerator
  34. 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
    TemplateGenerator
  35. def genEnum(enum: EnumRHS, fieldType: Option[FieldType] = None): CodeFragment

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

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  37. def genFieldType(f: Field): CodeFragment

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  38. def genID(data: Identifier): CodeFragment

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

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

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  41. def genOffsetSkipProtocolMethod(t: FunctionType): CodeFragment

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

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  43. def genProtocolReadMethod(t: FunctionType): CodeFragment

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

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

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

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

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

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  49. def genToImmutable(f: Field): CodeFragment

    Permalink
  50. def genToImmutable(t: FieldType): CodeFragment

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

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  52. def genUnion(struct: UnionRHS, fieldType: Option[FieldType] = None): CodeFragment

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  53. def genWireConstType(t: FunctionType): CodeFragment

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

    Permalink
    Definition Classes
    AnyRef → Any
  55. def getDependentHeaders(struct: StructLike): String

    Permalink
  56. def getDependentTypes(struct: StructLike): Set[FieldType]

    Permalink
  57. def getExceptionFields(result: FunctionResult): CodeFragment

    Permalink
    Definition Classes
    StructTemplate
  58. def getFieldNSCoderMethod(f: Field, isDecode: Boolean = false): String

    Permalink
  59. def getIncludeNamespace(includeFileName: String): Identifier

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  60. def getNamespace(doc: Document): Identifier

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  61. def getParentFinagleClient(p: ServiceParent): CodeFragment

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  62. def getParentFinagleService(p: ServiceParent): CodeFragment

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  63. def getServiceParentID(parent: ServiceParent): Identifier

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

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

    Permalink
    Definition Classes
    StructTemplate
  66. def getTypeValueMethod(t: FieldType, name: String): String

    Permalink
  67. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  68. val headerExtension: String

    Permalink
  69. val headerTemplateLoader: HandlebarLoader

    Permalink
  70. val implementationTemplateLoader: HandlebarLoader

    Permalink
  71. def includeMap: Map[String, ResolvedDocument]

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

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

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

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

    Permalink
    Definition Classes
    TemplateGenerator
  77. 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
    CocoaGeneratorGenerator
  78. def namespacedFolder(destFolder: File, namespace: String, dryRun: Boolean): File

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  81. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  83. 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
  84. 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
    CocoaGeneratorTemplateGenerator
  85. def quote(str: String): String

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

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

    Permalink
    Definition Classes
    CocoaGeneratorStructTemplate
  88. val resolvedDoc: ResolvedDocument

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

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

    Permalink
    Definition Classes
    CocoaGeneratorStructTemplate
  92. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  93. val templateDirName: String

    Permalink
  94. def templates: HandlebarLoader

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  95. def toMutable(f: Field): (String, String)

    Permalink
  96. def toMutable(t: FieldType): (String, String)

    Permalink
  97. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  98. 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
  99. def unwrapArgs(arity: Int): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. 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