org.coursera.courier.swift

Class SwiftSyntax

java.lang.Object

org.coursera.courier.swift.SwiftSyntax

public class SwiftSyntax
extends java.lang.Object

Provides utilities for code generating Swift source code.

Constructor Summary

Constructors

Constructor and Description
SwiftSyntax(com.linkedin.pegasus.generator.spec.ClassTemplateSpec classSpec, SwiftProperties swiftProperties, GlobalConfig globalConfig)

Method Summary

Modifier and Type	Method and Description
java.lang.String	defaultToLiteral(com.linkedin.pegasus.generator.spec.RecordTemplateSpec.Field field)
static java.lang.String	escapedFullname(com.linkedin.pegasus.generator.spec.ClassTemplateSpec spec) Returns the escaped fully qualified name of a ClassTemplateSpec.
static java.lang.String	escapeKeyword(java.lang.String symbol) Returns the escaped Pegasus symbol for use in Swift source code.
static java.lang.String	escapeString(java.lang.String value)
boolean	isEquatable()
boolean	isOptional(com.linkedin.pegasus.generator.spec.RecordTemplateSpec.Field field)
static java.lang.String	toLiteral(com.linkedin.data.schema.DataSchema schema, java.lang.Object value)
java.lang.String	toType(com.linkedin.pegasus.generator.spec.ClassTemplateSpec spec, boolean isOptional) Returns the Swift type of an optional field for the given ClassTemplateSpec as a Swift source code string.
static java.lang.String	toUnionMemberName(com.linkedin.pegasus.generator.spec.ClassTemplateSpec spec) Returns the union member class name for the given ClassTemplateSpec as a Swift source code string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwiftSyntax

public SwiftSyntax(com.linkedin.pegasus.generator.spec.ClassTemplateSpec classSpec,
                   SwiftProperties swiftProperties,
                   GlobalConfig globalConfig)

Method Detail

escapeKeyword

public static java.lang.String escapeKeyword(java.lang.String symbol)

Returns the escaped Pegasus symbol for use in Swift source code. Pegasus symbols must be of the form [A-Za-z_], so this routine simply checks if the symbol collides with a swift keyword, and if so, escapes it. (Because only fields are generated, symbols like hashCode do not collide with method names from Object and may be used).

Parameters:

symbol - the symbol to escape

Returns:

the escaped Pegasus symbol.

escapeString

public static java.lang.String escapeString(java.lang.String value)

escapedFullname

public static java.lang.String escapedFullname(com.linkedin.pegasus.generator.spec.ClassTemplateSpec spec)

Returns the escaped fully qualified name of a ClassTemplateSpec.

Parameters:

spec - to build a escaped fully qualified name for.

Returns:

the escaped fullname.

toType

public java.lang.String toType(com.linkedin.pegasus.generator.spec.ClassTemplateSpec spec,
                               boolean isOptional)

Returns the Swift type of an optional field for the given ClassTemplateSpec as a Swift source code string. Even if the field is required, it still will be represented as optional when Optionality is set to SwiftProperties.Optionality.REQUIRED_FIELDS_MAY_BE_ABSENT.

Parameters:

spec - to get a Swift type name for.

isOptional - indicates if the type is optional or not.

Returns:

Swift source code string identifying the given type.

isOptional

public boolean isOptional(com.linkedin.pegasus.generator.spec.RecordTemplateSpec.Field field)

isEquatable

public boolean isEquatable()

toUnionMemberName

public static java.lang.String toUnionMemberName(com.linkedin.pegasus.generator.spec.ClassTemplateSpec spec)

Returns the union member class name for the given ClassTemplateSpec as a Swift source code string.

Parameters:

spec - provides the union member type to get the name for.

Returns:

a Swift source code string identifying the union member.

defaultToLiteral

public java.lang.String defaultToLiteral(com.linkedin.pegasus.generator.spec.RecordTemplateSpec.Field field)

Parameters:

field - field to build a default literal for.

Returns:

A swift source code string representing the literal value of the field default, or null if the field does not have a default.

toLiteral

public static java.lang.String toLiteral(com.linkedin.data.schema.DataSchema schema,
                                         java.lang.Object value)