ObjFW
OFJSONRepresentation.h
1 /*
2  * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License version 3.0 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13  * version 3.0 for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * version 3.0 along with this program. If not, see
17  * <https://www.gnu.org/licenses/>.
18  */
19 
20 #import "OFObject.h"
21 
22 @class OFString;
23 
24 OF_ASSUME_NONNULL_BEGIN
25 
29 typedef enum {
31  OFJSONRepresentationOptionPretty = 0x01,
33  OFJSONRepresentationOptionJSON5 = 0x02,
35  OFJSONRepresentationOptionSorted = 0x04,
36  OFJSONRepresentationOptionIsIdentifier = 0x10
37 } OFJSONRepresentationOptions;
38 
53 @property (readonly, nonatomic) OFString *JSONRepresentation;
54 
61 - (OFString *)JSONRepresentationWithOptions:
62  (OFJSONRepresentationOptions)options;
63 @end
64 
65 OF_ASSUME_NONNULL_END
A protocol implemented by classes that support encoding to a JSON representation. ...
Definition: OFJSONRepresentation.h:49
A class for handling strings.
Definition: OFString.h:142
OFString * JSONRepresentation
The JSON representation of the object as a string.
Definition: OFJSONRepresentation.h:53