Class: FunctionCallStructField
A Function Call field with a struct value.
@interface FunctionCallStructField : FunctionCallField Properties
count
The number of fields in the struct.
@property (nonatomic, readonly) NSUInteger count; allKeys
A new array containing all the field names in the struct, or an empty array if the struct has no fields.
@property (readonly, copy, nonnull) NSArray<NSString*>* allKeys; allFields
A new array containing all the fields in the struct, or an empty array if the struct has no fields
@property (readonly, copy, nonnull) NSArray<FunctionCallField*>* allFields; Method: fieldWithName:
Creates and initializes an instance of a Function Call struct field.
Declaration
+(nullable instancetype)fieldWithName:(nonnull NSString*)fieldName; Parameters
| Parameter | Value |
|---|---|
| fieldName | The name of the field |
Returns
Returns the initialized field instance.
Exceptions
None
Method: fieldWithName:andFieldList:
Create and initialize an instance of a Function Call struct field.
Declaration
+(nullable instancetype)fieldWithName:(nonnull NSString*)fieldName andFieldList:(nullable NSArray<FunctionCallField*>*)fieldList; Parameters
| Parameter | Value |
|---|---|
| fieldName | The name of the field. |
| fieldList | The list of fields that are part of the structure. |
Returns
Returns the initialized field instance.
Exceptions
None
Method: initWithFieldName:
Initializes the Function Call string field, or initializes the Function Call struct field.
Declaration
-(nullable instancetype)initWithFieldName:(nonnull NSString*)fieldName; Parameters
| Parameter | Value |
|---|---|
| fieldName | The name of the field. |
Returns
Returns the initialized field instance.
Exceptions
None
Method: initWithFieldName:andFieldList:
Initialize the Function Call struct field.
Declaration
-(nullable instancetype)initWithFieldName:(nonnull NSString*)fieldName andFieldList:(nonnull NSArray<FunctionCallField*>*)fieldList; Parameters
| Parameter | Value |
|---|---|
| fieldName | The name of the field. |
| fieldList | The list of fields in the structure. |
Returns
Returns the initialized field instance.
Exceptions
None
Method: fieldForKey:
Gets a field from the structure by name.
Declaration
-(nullable FunctionCallField*)fieldForKey:(nonnull NSString*)key; Parameters
| Parameter | Value |
|---|---|
| key | The name of the field to get from the structure. |
Returns
Returns the field from the structure (nil if the structure doesn't contain a field with this name).
Exceptions
None
Method: fieldAtIndex:
Gets a field from the structure by index.
Declaration
-(nullable FunctionCallField*)fieldAtIndex:(NSUInteger)index; Parameters
| Parameter | Value |
|---|---|
| index | The 0-based index location of the field in the structure. |
Returns
Returns the field from the structure (nil if the index exceeds the bounds of the structure).
Exceptions
None
Method: addField:
Inserts a field at the end of the structure.
Declaration
-(void)addField:(nonnull FunctionCallField*)field; Parameters
| Parameter | Value |
|---|---|
| field | The field to add at the end of the structure's content. This value must not be nil. |
Returns
None
Exceptions
| Exception type | Reason |
|---|---|
| NSInvalidArgumentException | The field is nil. |
Loading...
There was a problem loading this topic