Class: NSPropertyListSerialization

Inherits:
NSObject show all

Overview

The NSPropertyListSerialization class provides methods that convert property list objects to and from several serialized formats. Property list objects include NSData, NSString, NSArray, NSDictionary, NSDate, and NSNumber objects. These objects are toll-free bridged with their respective Core Foundation types (CFData, CFString, and so on). For more about toll-free bridging, see “Interchangeable Data Types”.

Class Method Summary (collapse)

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Class Method Details

+ (NSData) dataFromPropertyList(plist, format:format, errorDescription:errorString)

This method is obsolete and will be deprecated soon. (Deprecated. Use dataWithPropertyList:format:options:error: instead.)

Parameters:

  • plist (Object) —

    A property list object.

  • format (NSPropertyListFormat) —

    A property list format. Possible values for format are described in NSPropertyListFormat.

  • errorString (Pointer) —

    Upon return, if the conversion is successful, errorString is nil. If the conversion fails, upon return contains a string describing the nature of the error.

Returns:

  • (NSData) —

    An NSData object containing plist in the format specified by format.

+ (NSData) dataWithPropertyList(plist, format:format, options:opt, error:error)

Returns an NSData object containing a given property list in a specified format.

Parameters:

  • plist (Object) —

    A property list object. Passing nil for this value will cause an exception to be raised.

  • format (NSPropertyListFormat) —

    A property list format. Possible values for format are described in NSPropertyListFormat.

  • opt (NSPropertyListWriteOptions) —

    The opt parameter is currently unused and should be set to 0.

  • error (Pointer) —

    If the method does not complete successfully, upon return contains an NSError object that describes the problem.

Returns:

  • (NSData) —

    An NSData object containing plist in the format specified by format.

+ (Boolean) propertyList(plist, isValidForFormat:format)

Returns a Boolean value that indicates whether a given property list is valid for a given format.

Parameters:

  • plist (Object) —

    A property list object.

  • format (NSPropertyListFormat) —

    A property list format. Possible values for format are listed in NSPropertyListFormat.

Returns:

  • (Boolean) —

    YES if plist is a valid property list in format format, otherwise NO.

+ (Object) propertyListFromData(data, mutabilityOption:opt, format:format, errorDescription:errorString)

This method is obsolete and will be deprecated soon. (Deprecated. Use propertyListWithData:options:format:error: instead.)

Parameters:

  • data (NSData) —

    A data object containing a serialized property list.

  • opt (NSPropertyListMutabilityOptions) —

    The opt parameter is currently unused and should be set to 0.

  • format (NSPropertyListFormat) —

    If the property list is valid, upon return contains the format. format can be NULL, in which case the property list format is not returned. Possible values are described in NSPropertyListFormat.

  • errorString (Pointer) —

    Upon return, if the conversion is successful, errorString is nil. If the conversion fails, upon return contains a string describing the nature of the error.

Returns:

  • (Object) —

    A property list object corresponding to the representation in data. If data is not in a supported format, returns nil.

+ (Object) propertyListWithData(data, options:opt, format:format, error:error)

Creates and returns a property list from the specified data.

Parameters:

  • data (NSData) —

    A data object containing a serialized property list.

  • opt (NSPropertyListReadOptions) —

    The options can be any of those listed in “NSPropertyListMutabilityOptions.”

  • format (NSPropertyListFormat) —

    Upon return, contains the format that the property list was stored in.Pass NULL, if you do not need to know the format. Possible values are described in NSPropertyListFormat.

  • error (Pointer) —

    If the method does not complete successfully, upon return contains an NSError object that describes the problem.

Returns:

  • (Object) —

    A property list object corresponding to the representation in data. If data is not in a supported format, returns nil.

+ (Object) propertyListWithStream(stream, options:opt, format:format, error:error)

Creates and returns a property list by reading from the specified stream.

Parameters:

  • stream (NSInputStream) —

    An NSStream object. The stream should be open and configured for reading.

  • opt (NSPropertyListReadOptions) —

    The options can be any of those listed in “NSPropertyListMutabilityOptions.”

  • format (NSPropertyListFormat) —

    A property list format. Possible values for format are described in NSPropertyListFormat.

  • error (Pointer) —

    Upon return, contains the format that the property list was stored in.Pass NULL, if you do not need to know the format. Possible values are described in NSPropertyListFormat.

Returns:

  • (Object) —

    A property list object corresponding to the representation in data. If data is not in a supported format, returns nil.

+ (Integer) writePropertyList(plist, toStream:stream, format:format, options:opt, error:error)

Writes the specified property list to the specified stream.

Parameters:

  • plist (Object) —

    A property list object. Passing nil for this value will cause an exception to be raised.

  • stream (NSOutputStream) —

    An NSStream object. The stream should be open and configured for reading.

  • format (NSPropertyListFormat) —

    A property list format. Possible values for format are described in NSPropertyListFormat.

  • opt (NSPropertyListWriteOptions) —

    The opt parameter is currently unused and should be set to 0.

  • error (Pointer) —

    If the method does not complete successfully, upon return contains an NSError object that describes the problem.

Returns:

  • (Integer) —

    Returns the number of bytes written to the stream. If the value is 0 an error occurred.