@@ -51,11 +51,15 @@ public interface PrettyPrinter
51
51
* Method called after a root-level value has been completely
52
52
* output, and before another value is to be output.
53
53
*<p>
54
- * Default
55
- * handling (without pretty-printing) will output a space, to
54
+ * Default handling (without pretty-printing) will output a space, to
56
55
* allow values to be parsed correctly. Pretty-printer is
57
56
* to output some other suitable and nice-looking separator
58
57
* (tab(s), space(s), linefeed(s) or any combination thereof).
58
+ *
59
+ * @param gen Generator used for output
60
+ *
61
+ * @throws IOException if there is either an underlying I/O problem or encoding
62
+ * issue at format layer
59
63
*/
60
64
void writeRootValueSeparator (JsonGenerator gen ) throws IOException ;
61
65
@@ -70,6 +74,11 @@ public interface PrettyPrinter
70
74
* Pretty-printer is
71
75
* to output a curly bracket as well, but can surround that
72
76
* with other (white-space) decoration.
77
+ *
78
+ * @param gen Generator used for output
79
+ *
80
+ * @throws IOException if there is either an underlying I/O problem or encoding
81
+ * issue at format layer
73
82
*/
74
83
void writeStartObject (JsonGenerator gen ) throws IOException ;
75
84
@@ -83,19 +92,28 @@ public interface PrettyPrinter
83
92
* to output a curly bracket as well, but can surround that
84
93
* with other (white-space) decoration.
85
94
*
86
- * @param nrOfEntries Number of direct members of the array that
95
+ * @param gen Generator used for output
96
+ * @param nrOfEntries Number of direct members of the Object that
87
97
* have been output
98
+ *
99
+ * @throws IOException if there is either an underlying I/O problem or encoding
100
+ * issue at format layer
88
101
*/
89
102
void writeEndObject (JsonGenerator gen , int nrOfEntries ) throws IOException ;
90
103
91
104
/**
92
- * Method called after an object entry (field:value) has been completely
105
+ * Method called after an Object entry (field:value) has been completely
93
106
* output, and before another value is to be output.
94
107
*<p>
95
108
* Default handling (without pretty-printing) will output a single
96
109
* comma to separate the two. Pretty-printer is
97
110
* to output a comma as well, but can surround that with other
98
111
* (white-space) decoration.
112
+ *
113
+ * @param gen Generator used for output
114
+ *
115
+ * @throws IOException if there is either an underlying I/O problem or encoding
116
+ * issue at format layer
99
117
*/
100
118
void writeObjectEntrySeparator (JsonGenerator gen ) throws IOException ;
101
119
@@ -107,6 +125,11 @@ public interface PrettyPrinter
107
125
* colon to separate the two. Pretty-printer is
108
126
* to output a colon as well, but can surround that with other
109
127
* (white-space) decoration.
128
+ *
129
+ * @param gen Generator used for output
130
+ *
131
+ * @throws IOException if there is either an underlying I/O problem or encoding
132
+ * issue at format layer
110
133
*/
111
134
void writeObjectFieldValueSeparator (JsonGenerator gen ) throws IOException ;
112
135
@@ -121,6 +144,11 @@ public interface PrettyPrinter
121
144
* Pretty-printer is
122
145
* to output a bracket as well, but can surround that
123
146
* with other (white-space) decoration.
147
+ *
148
+ * @param gen Generator used for output
149
+ *
150
+ * @throws IOException if there is either an underlying I/O problem or encoding
151
+ * issue at format layer
124
152
*/
125
153
void writeStartArray (JsonGenerator gen ) throws IOException ;
126
154
@@ -134,8 +162,12 @@ public interface PrettyPrinter
134
162
* to output a bracket as well, but can surround that
135
163
* with other (white-space) decoration.
136
164
*
165
+ * @param gen Generator used for output
137
166
* @param nrOfValues Number of direct members of the array that
138
167
* have been output
168
+ *
169
+ * @throws IOException if there is either an underlying I/O problem or encoding
170
+ * issue at format layer
139
171
*/
140
172
void writeEndArray (JsonGenerator gen , int nrOfValues ) throws IOException ;
141
173
@@ -147,14 +179,18 @@ public interface PrettyPrinter
147
179
* comma to separate the two. Pretty-printer is
148
180
* to output a comma as well, but can surround that with other
149
181
* (white-space) decoration.
182
+ *
183
+ * @param gen Generator used for output
184
+ *
185
+ * @throws IOException if there is either an underlying I/O problem or encoding
186
+ * issue at format layer
150
187
*/
151
188
void writeArrayValueSeparator (JsonGenerator gen ) throws IOException ;
152
189
153
190
/*
154
191
/**********************************************************
155
- /* Then events that by default do not produce any output
156
- /* but that are often overridden to add white space
157
- /* in pretty-printing mode
192
+ /* Then events that by default do not produce any output but that are
193
+ /* often overridden to add white space in pretty-printing mode
158
194
/**********************************************************
159
195
*/
160
196
@@ -165,6 +201,11 @@ public interface PrettyPrinter
165
201
*<p>
166
202
* Default handling does not output anything, but pretty-printer
167
203
* is free to add any white space decoration.
204
+ *
205
+ * @param gen Generator used for output
206
+ *
207
+ * @throws IOException if there is either an underlying I/O problem or encoding
208
+ * issue at format layer
168
209
*/
169
210
void beforeArrayValues (JsonGenerator gen ) throws IOException ;
170
211
@@ -176,6 +217,11 @@ public interface PrettyPrinter
176
217
*<p>
177
218
* Default handling does not output anything, but pretty-printer
178
219
* is free to add any white space decoration.
220
+ *
221
+ * @param gen Generator used for output
222
+ *
223
+ * @throws IOException if there is either an underlying I/O problem or encoding
224
+ * issue at format layer
179
225
*/
180
226
void beforeObjectEntries (JsonGenerator gen ) throws IOException ;
181
227
}
0 commit comments