ObjFW
OFJSONRepresentation.h
1 /*
2  * Copyright (c) 2008-2023 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This file is part of ObjFW. It may be distributed under the terms of the
7  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
8  * the packaging of this file.
9  *
10  * Alternatively, it may be distributed under the terms of the GNU General
11  * Public License, either version 2 or 3, which can be found in the file
12  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
13  * file.
14  */
15 
16 #import "OFObject.h"
17 
18 @class OFString;
19 
20 OF_ASSUME_NONNULL_BEGIN
21 
25 typedef enum {
27  OFJSONRepresentationOptionPretty = 0x01,
29  OFJSONRepresentationOptionJSON5 = 0x02,
30  OFJSONRepresentationOptionIsIdentifier = 0x10
31 } OFJSONRepresentationOptions;
32 
48 @property (readonly, nonatomic) OFString *JSONRepresentation;
49 
56 - (OFString *)JSONRepresentationWithOptions:
57  (OFJSONRepresentationOptions)options;
58 @end
59 
60 OF_ASSUME_NONNULL_END
A protocol implemented by classes that support encoding to a JSON representation. ...
Definition: OFJSONRepresentation.h:44
A class for handling strings.
Definition: OFString.h:134
OFString * JSONRepresentation
The JSON representation of the object as a string.
Definition: OFJSONRepresentation.h:48