c

com.twitter.scrooge.backend

CocoaGenerator

class CocoaGenerator extends TemplateGenerator

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

Instance Constructors

  1. new CocoaGenerator(doc: ResolvedDocument, defaultNamespace: String, headerTemplateLoader: HandlebarLoader, implementationTemplateLoader: HandlebarLoader)

Type Members

  1. implicit class RichDictionary extends AnyRef
  2. case class Binding[FT <: FieldType](name: String, fieldType: FT) extends Product with Serializable
    Definition Classes
    StructTemplate

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val TypeTemplate: Dictionary
    Definition Classes
    StructTemplate
  5. def apply(serviceOptions: Set[ServiceOption], outputPath: File, dryRun: Boolean = false, genAdapt: Boolean = false): Iterable[File]

    genAdapt

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

    Definition Classes
    CocoaGeneratorTemplateGeneratorGenerator
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val basePassthrough: Dictionary
    Definition Classes
    StructTemplate
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def constDict(namespace: Identifier, consts: Seq[ConstDefinition]): Dictionary
    Definition Classes
    ConstsTemplate
  10. var currentNamespace: String
  11. val defaultNamespace: String

    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
  13. def enumDict(namespace: Identifier, enum: Enum): Dictionary
    Definition Classes
    EnumTemplate
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def fieldsToDict(fields: Seq[Field], blacklist: Seq[String], namespace: Option[Identifier] = None): Seq[Dictionary]
    Definition Classes
    CocoaGeneratorStructTemplate
  17. val fileExtension: String
    Definition Classes
    CocoaGeneratorTemplateGenerator
  18. def finagleClient(service: Service, namespace: Identifier, withAsClosable: Boolean): Dictionary
    Definition Classes
    ServiceTemplate
  19. def finagleClientFile(packageDir: File, service: Service, options: Set[ServiceOption]): Option[File]
    Definition Classes
    TemplateGenerator
  20. def finagleService(service: Service, namespace: Identifier): Dictionary
    Definition Classes
    ServiceTemplate
  21. def finagleServiceFile(packageDir: File, service: Service, options: Set[ServiceOption]): Option[File]
    Definition Classes
    TemplateGenerator
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  23. def functionArgsStruct(f: Function): FunctionArgs
    Definition Classes
    ServiceTemplate
  24. def functionDictionary(function: Function, generic: Option[String]): Dictionary
    Definition Classes
    ServiceTemplate
  25. def functionObjectName(f: Function): SimpleID
    Definition Classes
    ServiceTemplate
  26. def genBaseFinagleService: CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  27. def genConstType(t: FunctionType): CodeFragment
    Definition Classes
    TemplateGenerator
  28. def genConstant(constant: RHS, fieldType: Option[FieldType] = None): CodeFragment
    Definition Classes
    TemplateGenerator
  29. def genDecodeProtocolMethod(t: FunctionType): CodeFragment
    Definition Classes
    TemplateGenerator
  30. def genDefaultFieldValue(f: Field, forAlternateConstructor: Boolean = false): Option[CodeFragment]

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

    The default value for the specified type and mutability.

    The default value for the specified type and mutability.

    Definition Classes
    TemplateGenerator
  34. def genEnum(enum: EnumRHS, fieldType: Option[FieldType] = None): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  35. def genFieldParams(fields: Seq[Field], asVal: Boolean = false): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  36. def genFieldType(f: Field): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  37. def genID(data: Identifier): CodeFragment
    Definition Classes
    TemplateGenerator
  38. def genList(list: ListRHS, fieldType: Option[FieldType] = None): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  39. def genMap(map: MapRHS, fieldType: Option[FieldType] = None): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  40. def genOffsetSkipProtocolMethod(t: FunctionType): CodeFragment
    Definition Classes
    TemplateGenerator
  41. def genPrimitiveType(t: FunctionType): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  42. def genProtocolReadMethod(t: FunctionType): CodeFragment
    Definition Classes
    TemplateGenerator
  43. def genProtocolSkipMethod(t: FunctionType): CodeFragment
    Definition Classes
    TemplateGenerator
  44. def genProtocolWriteMethod(t: FunctionType): CodeFragment
    Definition Classes
    TemplateGenerator
  45. def genQualifiedID(id: Identifier, namespace: Identifier): CodeFragment
    Definition Classes
    TemplateGenerator
  46. def genSet(set: SetRHS, fieldType: Option[FieldType]): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  47. def genStruct(struct: StructRHS, fieldType: Option[FieldType] = None): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  48. def genToImmutable(f: Field): CodeFragment
  49. def genToImmutable(t: FieldType): CodeFragment
  50. def genType(t: FunctionType, immutable: Boolean = false): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  51. def genUnion(struct: UnionRHS, fieldType: Option[FieldType] = None): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  52. def genUnsafeEmptyReadValue(f: Field): CodeFragment
    Definition Classes
    TemplateGenerator
  53. def genUnsafeEmptyValue(fieldType: FieldType): CodeFragment

    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.

    Definition Classes
    TemplateGenerator
  54. def genWireConstType(t: FunctionType): CodeFragment
    Definition Classes
    StructTemplate
  55. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. def getDependentHeaders(struct: StructLike): String
  57. def getDependentTypes(struct: StructLike): Set[FieldType]
  58. def getExceptionFields(result: FunctionResult): CodeFragment
    Definition Classes
    StructTemplate
  59. def getFieldNSCoderMethod(f: Field, isDecode: Boolean = false): String
  60. def getIncludeNamespace(includeFileName: String): Identifier
    Definition Classes
    CocoaGeneratorTemplateGenerator
  61. def getNamespace(doc: Document): Identifier
    Definition Classes
    CocoaGeneratorTemplateGenerator
  62. def getParentFinagleClient(p: ServiceParent): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  63. def getParentFinagleService(p: ServiceParent): CodeFragment
    Definition Classes
    CocoaGeneratorTemplateGenerator
  64. def getServiceParentID(parent: ServiceParent): Identifier
    Definition Classes
    TemplateGenerator
  65. def getSuccessType(result: FunctionResult): CodeFragment
    Definition Classes
    StructTemplate
  66. def getSuccessValue(result: FunctionResult): CodeFragment
    Definition Classes
    StructTemplate
  67. def getTypeValueMethod(t: FieldType, name: String): String
  68. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  69. val headerExtension: String
  70. val headerTemplateLoader: HandlebarLoader
  71. val implementationTemplateLoader: HandlebarLoader
  72. def includeMap: Map[String, ResolvedDocument]
    Definition Classes
    Generator
  73. 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
  74. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  75. def isLazyReadEnabled(t: FunctionType, optional: Boolean): Boolean
    Definition Classes
    CocoaGeneratorTemplateGenerator
  76. def isNullableType(t: FieldType, isOptional: Boolean = false): Boolean
    Definition Classes
    TemplateGenerator
  77. def isPrimitive(t: FunctionType): Boolean
    Definition Classes
    TemplateGenerator
  78. val languageFlags: Seq[String]
    Definition Classes
    CocoaGeneratorTemplateGenerator
  79. val namespaceLanguage: String

    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
  80. def namespacedFolder(destFolder: File, namespace: String, dryRun: Boolean): File

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

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

    Attributes
    protected
    Definition Classes
    TemplateGenerator
  81. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  82. def normalizeCase[N <: Node](node: N): N
    Definition Classes
    CocoaGeneratorTemplateGenerator
  83. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. def productN(fields: Seq[Field], namespace: Option[Identifier]): String

    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
  86. def qualifyNamedType(t: NamedType, namespace: Option[Identifier] = None): 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
    CocoaGeneratorTemplateGenerator
  87. def quote(str: String): String
    Definition Classes
    TemplateGenerator
  88. def quoteKeyword(str: String): String
    Definition Classes
    CocoaGeneratorTemplateGenerator
  89. def readWriteInfo[T <: FieldType](sid: SimpleID, t: FieldType): Dictionary
    Definition Classes
    CocoaGeneratorStructTemplate
  90. val resolvedDoc: ResolvedDocument
    Definition Classes
    TemplateGenerator
  91. def resultStruct(f: Function): FunctionResult

    Thrift Result struct that includes success or exceptions returned.

    Thrift Result struct that includes success or exceptions returned.

    Definition Classes
    ServiceTemplate
  92. def serviceDict(service: Service, namespace: Identifier, includes: Seq[Include], options: Set[ServiceOption], genAdapt: Boolean): Dictionary
    Definition Classes
    ServiceTemplate
  93. def structDict(struct: StructLike, namespace: Option[Identifier], includes: Seq[Include], serviceOptions: Set[ServiceOption], genAdapt: Boolean, toplevel: Boolean = false): Dictionary
    Definition Classes
    CocoaGeneratorStructTemplate
  94. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  95. val templateDirName: String
  96. def templates: HandlebarLoader
    Definition Classes
    CocoaGeneratorTemplateGenerator
  97. def toMutable(f: Field): (String, String)
  98. def toMutable(t: FieldType): (String, String)
  99. def toString(): String
    Definition Classes
    AnyRef → Any
  100. def tupleN(fields: Seq[Field], namespace: Option[Identifier]): String

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

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

    Definition Classes
    TemplateGenerator
  101. def unwrapArgs(arity: Int): String
    Definition Classes
    ServiceTemplate
  102. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  103. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  104. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  105. def writeFile(file: File, fileHeader: String, fileContent: String): Unit
    Attributes
    protected
    Definition Classes
    CocoaGeneratorTemplateGenerator

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