Class CFPropertyList::List
In: lib/cfpropertylist/rbCFPropertyList.rb
Parent: Object

Class representing a CFPropertyList. Instanciate with new

Methods

load   load_binary   load_binary_str   load_plain   load_plain_str   load_str   load_xml   load_xml_str   new   parsers   parsers=   save   to_str  

Constants

FORMAT_BINARY = 1   Format constant for binary format
FORMAT_XML = 2   Format constant for XML format
FORMAT_PLAIN = 3   Format constant for the old plain format
FORMAT_AUTO = 0   Format constant for automatic format recognizing

Attributes

filename  [RW]  Path of PropertyList
format  [RW]  the original format of the PropertyList
formatted  [RW]  default value for XML generation; if true generate formatted XML
value  [RW]  the root value in the plist file

Public Class methods

new(opts={})

initialize a new CFPropertyList, arguments are:

:file:Parse a file
:format:Format is one of FORMAT_BINARY or FORMAT_XML. Defaults to FORMAT_AUTO
:data:Parse a string

All arguments are optional

parsers()

returns a list of registered parsers

parsers=(val)

set a list of parsers

Public Instance methods

load(file=nil,format=nil)

Read a plist file

file = nil:The filename of the file to read. If nil, use filename instance variable
format = nil:The format of the plist file. Auto-detect if nil
load_binary(filename=nil)

read a binary plist file

filename = nil:The filename to read from; if nil, read from the file defined by instance variable filename
load_binary_str(str=nil)

load a plist from a binary string

str:The string containing the plist
load_plain(filename=nil)

read a plain plist file

filename = nil:The filename to read from; if nil, read from the file defined by instance variable filename
load_plain_str(str=nil)

load a plist from a plain string

str:The string containing the plist
load_str(str=nil,format=nil)

load a plist from a string

str = nil:The string containing the plist
format = nil:The format of the plist
load_xml(filename=nil)

Load an XML PropertyList

filename = nil:The filename to read from; if nil, read from the file defined by instance variable filename
load_xml_str(str=nil)

load a plist from a XML string

str:The string containing the plist
save(file=nil,format=nil,opts={})

Serialize CFPropertyList object to specified format and write it to file

file = nil:The filename of the file to write to. Uses filename instance variable if nil
format = nil:The format to save in. Uses format instance variable if nil
to_str(format=List::FORMAT_BINARY,opts={})

convert plist to string

format = List::FORMAT_BINARY:The format to save the plist
opts={}:Pass parser options

[Validate]