UNICORN - iOS
SBJsonWriter.h
1 /*
2  Copyright (C) 2009 Stig Brautaset. All rights reserved.
3 
4  Redistribution and use in source and binary forms, with or without
5  modification, are permitted provided that the following conditions are met:
6 
7  * Redistributions of source code must retain the above copyright notice, this
8  list of conditions and the following disclaimer.
9 
10  * Redistributions in binary form must reproduce the above copyright notice,
11  this list of conditions and the following disclaimer in the documentation
12  and/or other materials provided with the distribution.
13 
14  * Neither the name of the author nor the names of its contributors may be used
15  to endorse or promote products derived from this software without specific
16  prior written permission.
17 
18  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #import <Foundation/Foundation.h>
31 
40 @interface SBJsonWriter : NSObject
41 
49 @property NSUInteger maxDepth;
50 
58 @property (readonly, copy) NSString *error;
59 
68 @property BOOL humanReadable;
69 
76 @property BOOL sortKeys;
77 
83 @property (copy) NSComparator sortKeysComparator;
84 
93 - (NSString*)stringWithObject:(id)value;
94 
102 - (NSData*)dataWithObject:(id)value;
103 - (NSString*)stringWithObject:(id)value
114  error:(NSError**)error;
115 
116 
117 @end
BOOL sortKeys
Whether or not to sort the dictionary keys in the output.
Definition: SBJsonWriter.h:76
The JSON writer class.
Definition: SBJsonWriter.h:40
NSString * error
Return an error trace, or nil if there was no errors.
Definition: SBJsonWriter.h:58
NSComparator sortKeysComparator
An optional comparator to be used if sortKeys is YES.
Definition: SBJsonWriter.h:83
BOOL humanReadable
Whether we are generating human-readable (multiline) JSON.
Definition: SBJsonWriter.h:68
NSUInteger maxDepth
The maximum recursing depth.
Definition: SBJsonWriter.h:49