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. def fieldsToDict(fields: Seq[Field], blacklist: Seq[String], namespace: Option[Identifier] = None): Seq[Dictionary]

    Permalink
    Definition Classes
    CocoaGeneratorStructTemplate
  17. val fileExtension: String

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ServiceTemplate
  26. def genBaseFinagleService: CodeFragment

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    CocoaGeneratorTemplateGenerator
  52. def genUnsafeEmptyReadValue(f: Field): CodeFragment

    Permalink
    Definition Classes
    TemplateGenerator
  53. 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.

    Definition Classes
    TemplateGenerator
  54. def genWireConstType(t: FunctionType): CodeFragment

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  68. def hashCode(): Int

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

    Permalink
  70. val headerTemplateLoader: HandlebarLoader

    Permalink
  71. val implementationTemplateLoader: HandlebarLoader

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

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

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

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

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

    Permalink
    Definition Classes
    TemplateGenerator
  78. val languageFlags: Seq[String]

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

    Permalink

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    CocoaGeneratorStructTemplate
  90. val resolvedDoc: ResolvedDocument

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

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

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

    Permalink
    Definition Classes
    AnyRef
  95. val templateDirName: String

    Permalink
  96. def templates: HandlebarLoader

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

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

    Permalink
  99. def toString(): String

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

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

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

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

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