FMSerializer Class Reference

Inherits from NSObject
Declared in FM.h

Overview

Provides methods for serializing/deserializing .NET value types as well as facilities for converting objects and arrays if appropriate callbacks are supplied to assist with the conversion.

+ deserializeBooleanArrayWithArrayJson:

Deserializes a boolean array from JSON.

+ (NSMutableArray *)deserializeBooleanArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized boolean array. An array of boolean values.

Discussion

Deserializes a boolean array from JSON.

Declared In

FM.h

+ deserializeBooleanArrayWithJson:

Deserializes a boolean array from JSON.

+ (NSMutableArray *)deserializeBooleanArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized boolean array. An array of boolean values.

Discussion

Deserializes a boolean array from JSON.

Declared In

FM.h

+ deserializeBooleanWithValueJson:

Deserializes a boolean value.

+ (FMNullableBool *)deserializeBooleanWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

boolean JSON to deserialize. The deserialized boolean value.

Discussion

Deserializes a boolean value.

Declared In

FM.h

+ deserializeDecimalArrayWithArrayJson:

Deserializes a decimal array from JSON.

+ (NSMutableArray *)deserializeDecimalArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized decimal array. An array of decimal values.

Discussion

Deserializes a decimal array from JSON.

Declared In

FM.h

+ deserializeDecimalArrayWithJson:

Deserializes a decimal array from JSON.

+ (NSMutableArray *)deserializeDecimalArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized decimal array. An array of decimal values.

Discussion

Deserializes a decimal array from JSON.

Declared In

FM.h

+ deserializeDecimalWithValueJson:

Deserializes a decimal value.

+ (FMNullableDecimal *)deserializeDecimalWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

decimal JSON to deserialize. The deserialized decimal value.

Discussion

Deserializes a decimal value.

Declared In

FM.h

+ deserializeDoubleArrayWithArrayJson:

Deserializes a double array from JSON.

+ (NSMutableArray *)deserializeDoubleArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized double array. An array of double values.

Discussion

Deserializes a double array from JSON.

Declared In

FM.h

+ deserializeDoubleArrayWithJson:

Deserializes a double array from JSON.

+ (NSMutableArray *)deserializeDoubleArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized double array. An array of double values.

Discussion

Deserializes a double array from JSON.

Declared In

FM.h

+ deserializeDoubleWithValueJson:

Deserializes a double value.

+ (FMNullableDouble *)deserializeDoubleWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

double JSON to deserialize. The deserialized double value.

Discussion

Deserializes a double value.

Declared In

FM.h

+ deserializeFloatArrayWithArrayJson:

Deserializes a float array from JSON.

+ (NSMutableArray *)deserializeFloatArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized float array. An array of float values.

Discussion

Deserializes a float array from JSON.

Declared In

FM.h

+ deserializeFloatArrayWithJson:

Deserializes a float array from JSON.

+ (NSMutableArray *)deserializeFloatArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized float array. An array of float values.

Discussion

Deserializes a float array from JSON.

Declared In

FM.h

+ deserializeFloatWithValueJson:

Deserializes a float value.

+ (FMNullableFloat *)deserializeFloatWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

float JSON to deserialize. The deserialized float value.

Discussion

Deserializes a float value.

Declared In

FM.h

+ deserializeGuidArrayWithArrayJson:

Deserializes a GUID array from JSON.

+ (NSMutableArray *)deserializeGuidArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized GUID array. An array of GUID values.

Discussion

Deserializes a GUID array from JSON.

Declared In

FM.h

+ deserializeGuidArrayWithJson:

Deserializes a GUID array from JSON.

+ (NSMutableArray *)deserializeGuidArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized GUID array. An array of GUID values.

Discussion

Deserializes a GUID array from JSON.

Declared In

FM.h

+ deserializeGuidWithValueJson:

Deserializes a globally unique identifier.

+ (FMNullableGuid *)deserializeGuidWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

GUID JSON to deserialize. The deserialized GUID.

Discussion

Deserializes a globally unique identifier.

Declared In

FM.h

+ deserializeIntegerArrayWithArrayJson:

Deserializes a integer array from JSON.

+ (NSMutableArray *)deserializeIntegerArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized integer array. An array of integer values.

Discussion

Deserializes a integer array from JSON.

Declared In

FM.h

+ deserializeIntegerArrayWithJson:

Deserializes a integer array from JSON.

+ (NSMutableArray *)deserializeIntegerArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized integer array. An array of integer values.

Discussion

Deserializes a integer array from JSON.

Declared In

FM.h

+ deserializeIntegerWithValueJson:

Deserializes an integer value.

+ (FMNullableInt *)deserializeIntegerWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

integer JSON to deserialize. The deserialized integer value.

Discussion

Deserializes an integer value.

Declared In

FM.h

+ deserializeLongArrayWithArrayJson:

Deserializes a long array from JSON.

+ (NSMutableArray *)deserializeLongArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized long array. An array of long values.

Discussion

Deserializes a long array from JSON.

Declared In

FM.h

+ deserializeLongArrayWithJson:

Deserializes a long array from JSON.

+ (NSMutableArray *)deserializeLongArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized long array. An array of long values.

Discussion

Deserializes a long array from JSON.

Declared In

FM.h

+ deserializeLongWithValueJson:

Deserializes a long value.

+ (FMNullableLong *)deserializeLongWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

long JSON to deserialize. The deserialized long value.

Discussion

Deserializes a long value.

Declared In

FM.h

+ deserializeObjectArrayFastWithJson:creator:callback:

Deserializes a JSON string into an array of target object types. The type of the object to deserialize.

+ (NSMutableArray *)deserializeObjectArrayFastWithJson:(NSString *)json creator:(FMCallback *)creator callback:(FMCallback *)callback

Parameters

name="creator">The

method used for creating an object.
name="json">The

JSON-encoded string.
name="callback">The

method used for deserializing an object. An array of deserialized objects.

Discussion

Deserializes a JSON string into an array of target object types. The type of the object to deserialize.

Declared In

FM.h

+ deserializeObjectArrayWithJson:creator:callback:

Deserializes a JSON string into an array of target object types. The type of the object to deserialize.

+ (NSMutableArray *)deserializeObjectArrayWithJson:(NSString *)json creator:(FMCallback *)creator callback:(FMCallback *)callback

Parameters

name="creator">The

method used for creating an object.
name="json">The

JSON-encoded string.
name="callback">The

method used for deserializing an object. An array of deserialized objects.

Discussion

Deserializes a JSON string into an array of target object types. The type of the object to deserialize.

Declared In

FM.h

+ deserializeObjectFastWithJson:creator:callback:

Deserializes a JSON string into a target object type. The type of the object to deserialize.

+ (FMSerializable *)deserializeObjectFastWithJson:(NSString *)json creator:(FMCallback *)creator callback:(FMCallback *)callback

Parameters

name="creator">The

method used for creating a new object.
name="json">The

JSON-encoded string.
name="callback">The

method used for deserializing a property. The deserialized object.

Discussion

Deserializes a JSON string into a target object type. The type of the object to deserialize.

Declared In

FM.h

+ deserializeObjectWithJson:creator:callback:

Deserializes a JSON string into a target object type. The type of the object to deserialize.

+ (NSObject *)deserializeObjectWithJson:(NSString *)json creator:(FMCallback *)creator callback:(FMCallback *)callback

Parameters

name="creator">The

method used for creating a new object.
name="json">The

JSON-encoded string.
name="callback">The

method used for deserializing a property. The deserialized object.

Discussion

Deserializes a JSON string into a target object type. The type of the object to deserialize.

Declared In

FM.h

+ deserializeRawArrayWithJson:

Deserializes a raw array from JSON.

+ (NSMutableArray *)deserializeRawArrayWithJson:(NSString *)json

Parameters

name="json">A

JSON-serialized raw array. An array of raw values.

Discussion

Deserializes a raw array from JSON.

Declared In

FM.h

+ deserializeRawWithDataJson:

Deserializes a piece of raw JSON.

+ (NSString *)deserializeRawWithDataJson:(NSString *)dataJson

Parameters

name="dataJson">The

raw data. The deserialized data.

Discussion

Deserializes a piece of raw JSON.

Declared In

FM.h

+ deserializeStringArrayWithArrayJson:

Deserializes a simple string array from JSON (no commas in strings).

+ (NSMutableArray *)deserializeStringArrayWithArrayJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized string array. An array of string values.

Discussion

Deserializes a simple string array from JSON (no commas in strings).

Declared In

FM.h

+ deserializeStringArrayWithJson:

Deserializes a simple string array from JSON (no commas in strings).

+ (NSMutableArray *)deserializeStringArrayWithJson:(NSString *)arrayJson

Parameters

name="arrayJson">A

JSON-serialized string array. An array of string values.

Discussion

Deserializes a simple string array from JSON (no commas in strings).

Declared In

FM.h

+ deserializeStringWithValueJson:

Deserializes a string.

+ (NSString *)deserializeStringWithValueJson:(NSString *)valueJson

Parameters

name="valueJson">The

string to deserialize. The deserialized string value.

Discussion

Deserializes a string.

Declared In

FM.h

+ escapeStringWithText:

Escapes any special characters in a string.

+ (NSString *)escapeStringWithText:(NSString *)text

Parameters

name="text">The

string without escaped characters. The escaped string.

Discussion

Escapes any special characters in a string.

Declared In

FM.h

+ isValidJsonWithJson:

Determines whether the specified JSON string is valid.

+ (bool)isValidJsonWithJson:(NSString *)json

Parameters

name="json">The

JSON string to validate. True if the JSON string is valid; false otherwise.

Discussion

Determines whether the specified JSON string is valid.

Declared In

FM.h

+ isValidJson:

Determines whether the specified JSON string is valid.

+ (bool)isValidJson:(NSString *)json

Parameters

name="json">The

JSON string to validate. True if the JSON string is valid; false otherwise.

Discussion

Determines whether the specified JSON string is valid.

Declared In

FM.h

+ serializeBooleanArrayWithArray:

Serializes a boolean array to JSON.

+ (NSString *)serializeBooleanArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of boolean values. A JSON-serialized boolean array.

Discussion

Serializes a boolean array to JSON.

Declared In

FM.h

+ serializeBooleanArray:

Serializes a boolean array to JSON.

+ (NSString *)serializeBooleanArray:(NSMutableArray *)array

Parameters

name="array">An

array of boolean values. A JSON-serialized boolean array.

Discussion

Serializes a boolean array to JSON.

Declared In

FM.h

+ serializeBooleanWithValue:

Serializes a boolean value.

+ (NSString *)serializeBooleanWithValue:(FMNullableBool *)value

Parameters

name="value">The

boolean to serialize. The serialized boolean value.

Discussion

Serializes a boolean value.

Declared In

FM.h

+ serializeDecimalArrayWithArray:

Serializes a decimal array to JSON.

+ (NSString *)serializeDecimalArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of decimal values. A JSON-serialized decimal array.

Discussion

Serializes a decimal array to JSON.

Declared In

FM.h

+ serializeDecimalArray:

Serializes a decimal array to JSON.

+ (NSString *)serializeDecimalArray:(NSMutableArray *)array

Parameters

name="array">An

array of decimal values. A JSON-serialized decimal array.

Discussion

Serializes a decimal array to JSON.

Declared In

FM.h

+ serializeDecimalWithValue:

Serializes a decimal value.

+ (NSString *)serializeDecimalWithValue:(FMNullableDecimal *)value

Parameters

name="value">The

decimal to serialize. The serialized decimal value.

Discussion

Serializes a decimal value.

Declared In

FM.h

+ serializeDoubleArrayWithArray:

Serializes a double array to JSON.

+ (NSString *)serializeDoubleArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of double values. A JSON-serialized double array.

Discussion

Serializes a double array to JSON.

Declared In

FM.h

+ serializeDoubleArray:

Serializes a double array to JSON.

+ (NSString *)serializeDoubleArray:(NSMutableArray *)array

Parameters

name="array">An

array of double values. A JSON-serialized double array.

Discussion

Serializes a double array to JSON.

Declared In

FM.h

+ serializeDoubleWithValue:

Serializes a double value.

+ (NSString *)serializeDoubleWithValue:(FMNullableDouble *)value

Parameters

name="value">The

double to serialize. The serialized double value.

Discussion

Serializes a double value.

Declared In

FM.h

+ serializeFloatArrayWithArray:

Serializes a float array to JSON.

+ (NSString *)serializeFloatArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of float values. A JSON-serialized float array.

Discussion

Serializes a float array to JSON.

Declared In

FM.h

+ serializeFloatArray:

Serializes a float array to JSON.

+ (NSString *)serializeFloatArray:(NSMutableArray *)array

Parameters

name="array">An

array of float values. A JSON-serialized float array.

Discussion

Serializes a float array to JSON.

Declared In

FM.h

+ serializeFloatWithValue:

Serializes a float value.

+ (NSString *)serializeFloatWithValue:(FMNullableFloat *)value

Parameters

name="value">The

float to serialize. The serialized float value.

Discussion

Serializes a float value.

Declared In

FM.h

+ serializeGuidArrayWithArray:

Serializes a GUID array to JSON.

+ (NSString *)serializeGuidArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of GUID values. A JSON-serialized GUID array.

Discussion

Serializes a GUID array to JSON.

Declared In

FM.h

+ serializeGuidArray:

Serializes a GUID array to JSON.

+ (NSString *)serializeGuidArray:(NSMutableArray *)array

Parameters

name="array">An

array of GUID values. A JSON-serialized GUID array.

Discussion

Serializes a GUID array to JSON.

Declared In

FM.h

+ serializeGuidWithValue:

Serializes a globally unique identifier.

+ (NSString *)serializeGuidWithValue:(FMNullableGuid *)value

Parameters

name="value">The

GUID to serialize. The serialized GUID.

Discussion

Serializes a globally unique identifier.

Declared In

FM.h

+ serializeIntegerArrayWithArray:

Serializes a integer array to JSON.

+ (NSString *)serializeIntegerArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of integer values. A JSON-serialized integer array.

Discussion

Serializes a integer array to JSON.

Declared In

FM.h

+ serializeIntegerArray:

Serializes a integer array to JSON.

+ (NSString *)serializeIntegerArray:(NSMutableArray *)array

Parameters

name="array">An

array of integer values. A JSON-serialized integer array.

Discussion

Serializes a integer array to JSON.

Declared In

FM.h

+ serializeIntegerWithValue:

Serializes an integer value.

+ (NSString *)serializeIntegerWithValue:(FMNullableInt *)value

Parameters

name="value">The

integer to serialize. The serialized integer value.

Discussion

Serializes an integer value.

Declared In

FM.h

+ serializeLongArrayWithArray:

Serializes a long array to JSON.

+ (NSString *)serializeLongArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of long values. A JSON-serialized long array.

Discussion

Serializes a long array to JSON.

Declared In

FM.h

+ serializeLongArray:

Serializes a long array to JSON.

+ (NSString *)serializeLongArray:(NSMutableArray *)array

Parameters

name="array">An

array of long values. A JSON-serialized long array.

Discussion

Serializes a long array to JSON.

Declared In

FM.h

+ serializeLongWithValue:

Serializes a long value.

+ (NSString *)serializeLongWithValue:(FMNullableLong *)value

Parameters

name="value">The

long to serialize. The serialized long value.

Discussion

Serializes a long value.

Declared In

FM.h

+ serializeObjectArrayFastWithObjects:callback:

Serializes a object array into a JSON string. The type of the object to serialize.

+ (NSString *)serializeObjectArrayFastWithObjects:(NSMutableArray *)objects callback:(FMCallback *)callback

Parameters

name="objects">The

object array being serialized.
name="callback">The

method used for serializing objects. The object array as a JSON string.

Discussion

Serializes a object array into a JSON string. The type of the object to serialize.

Declared In

FM.h

+ serializeObjectArrayWithObjects:callback:

Serializes an object array into a JSON string. The type of the object to serialize.

+ (NSString *)serializeObjectArrayWithObjects:(NSMutableArray *)objects callback:(FMCallback *)callback

Parameters

name="objects">The

object array being serialized.
name="callback">The

method used for serializing objects. The object array as a JSON string.

Discussion

Serializes an object array into a JSON string. The type of the object to serialize.

Declared In

FM.h

+ serializeObjectFastWithSource:callback:

Serializes a object into a JSON string. The type of the object to serialize.

+ (NSString *)serializeObjectFastWithSource:(FMSerializable *)source callback:(FMCallback *)callback

Parameters

name="source">The

object being serialized.
name="callback">The

method used for serializing properties. The object as a JSON string.

Discussion

Serializes a object into a JSON string. The type of the object to serialize.

Declared In

FM.h

+ serializeObjectWithSource:callback:

Serializes an object into a JSON string. The type of the object to serialize.

+ (NSString *)serializeObjectWithSource:(NSObject *)source callback:(FMCallback *)callback

Parameters

name="source">The

object being serialized.
name="callback">The

method used for serializing properties. The object as a JSON string.

Discussion

Serializes an object into a JSON string. The type of the object to serialize.

Declared In

FM.h

+ serializeRawArrayWithJsons:

Serializes a raw array to JSON.

+ (NSString *)serializeRawArrayWithJsons:(NSMutableArray *)jsons

Parameters

name="jsons">An

array of raw values. A JSON-serialized raw array.

Discussion

Serializes a raw array to JSON.

Declared In

FM.h

+ serializeRawWithDataJson:

Serializes a piece of raw JSON.

+ (NSString *)serializeRawWithDataJson:(NSString *)dataJson

Parameters

name="dataJson">The

raw data. The serialized data.

Discussion

Serializes a piece of raw JSON.

Declared In

FM.h

+ serializeStringArrayWithArray:

Serializes a string array to JSON.

+ (NSString *)serializeStringArrayWithArray:(NSMutableArray *)array

Parameters

name="array">An

array of string values. A JSON-serialized string array.

Discussion

Serializes a string array to JSON.

Declared In

FM.h

+ serializeStringArray:

Serializes a string array to JSON.

+ (NSString *)serializeStringArray:(NSMutableArray *)array

Parameters

name="array">An

array of string values. A JSON-serialized string array.

Discussion

Serializes a string array to JSON.

Declared In

FM.h

+ serializeStringWithValue:

Serializes a string.

+ (NSString *)serializeStringWithValue:(NSString *)value

Parameters

name="value">The

string to serialize. The serialized string value.

Discussion

Serializes a string.

Declared In

FM.h

+ trimQuotesWithValue:

Trims the quotes from a JavaScript string value.

+ (NSString *)trimQuotesWithValue:(NSString *)value

Parameters

name="value">The

JavaScript string value. The string without quotes.

Discussion

Trims the quotes from a JavaScript string value.

Declared In

FM.h

+ unescapeStringWithText:

Unescapes any special characters from a string.

+ (NSString *)unescapeStringWithText:(NSString *)text

Parameters

name="text">The

string with escaped characters. The unescaped string.

Discussion

Unescapes any special characters from a string.

Declared In

FM.h