org.coursera.courier.swift

Enum SwiftProperties.Optionality

java.lang.Object

java.lang.Enum<SwiftProperties.Optionality>

org.coursera.courier.swift.SwiftProperties.Optionality

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SwiftProperties.Optionality>

Enclosing class:

SwiftProperties

public static enum SwiftProperties.Optionality
extends java.lang.Enum<SwiftProperties.Optionality>

"optionality" property. Swift representations of Pegasus primitive types supported by this generator.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REQUIRED_FIELDS_MAY_BE_ABSENT Allows required fields to be absent, useful when working with projections.
STRICT WARNING: this mode is unsafe when used in conjunction with projections, as a read/modify/coercerOutput pattern on a projection could result in the default value of primitives (e.g.

Method Summary

Methods

Modifier and Type	Method and Description
static SwiftProperties.Optionality	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SwiftProperties.Optionality[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUIRED_FIELDS_MAY_BE_ABSENT

public static final SwiftProperties.Optionality REQUIRED_FIELDS_MAY_BE_ABSENT

Allows required fields to be absent, useful when working with projections. "nil" is used to represent un-projected fields (required or optional) as well as absent optional fields.

STRICT

public static final SwiftProperties.Optionality STRICT

WARNING: this mode is unsafe when used in conjunction with projections, as a read/modify/coercerOutput pattern on a projection could result in the default value of primitives (e.g. 0 for ints) to be accidentally written. Required fields generated as non-optional Swift properties. Optional fields are generated as optional Swift properties, where an absent optional field value is represented as `nil`. When reading JSON, if a required field is absent, the field in data binding will default to the schema defined default value. When writing JSON, all required primitive fields will be written, even if they are the schema defined default value.

Method Detail

values

public static SwiftProperties.Optionality[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SwiftProperties.Optionality c : SwiftProperties.Optionality.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SwiftProperties.Optionality valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null