001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.json;
014
015import static org.apache.juneau.json.JsonParser.*;
016
017import java.util.*;
018
019import org.apache.juneau.*;
020import org.apache.juneau.http.*;
021import org.apache.juneau.parser.*;
022
023/**
024 * Builder class for building instances of JSON parsers.
025 */
026public class JsonParserBuilder extends ParserBuilder {
027
028   /**
029    * Constructor, default settings.
030    */
031   public JsonParserBuilder() {
032      super();
033   }
034
035   /**
036    * Constructor.
037    * 
038    * @param ps The initial configuration settings for this builder.
039    */
040   public JsonParserBuilder(PropertyStore ps) {
041      super(ps);
042   }
043
044   @Override /* ContextBuilder */
045   public JsonParser build() {
046      return build(JsonParser.class);
047   }
048
049
050   //--------------------------------------------------------------------------------
051   // Properties
052   //--------------------------------------------------------------------------------
053
054   /**
055    * Configuration property:  Validate end.
056    * 
057    * <p>
058    * If <jk>true</jk>, after parsing a POJO from the input, verifies that the remaining input in 
059    * the stream consists of only comments or whitespace.
060    * 
061    * <h5 class='section'>See Also:</h5>
062    * <ul>
063    *    <li class='jf'>{@link JsonParser#JSON_validateEnd}
064    * </ul>
065    * 
066    * @param value 
067    *    The new value for this property.
068    *    <br>The default value is <jk>false</jk>.
069    * @return This object (for method chaining).
070    */
071   public JsonParserBuilder validateEnd(boolean value) {
072      return set(JSON_validateEnd, value);
073   }
074   
075   /**
076    * Configuration property:  Validate end.
077    * 
078    * <p>
079    * Shortcut for calling <code>validateEnd(<jk>true</jk>)</code>.
080    * 
081    * <h5 class='section'>See Also:</h5>
082    * <ul>
083    *    <li class='jf'>{@link JsonParser#JSON_validateEnd}
084    * </ul>
085    * 
086    * @return This object (for method chaining).
087    */
088   public JsonParserBuilder validateEnd() {
089      return set(JSON_validateEnd, true);
090   }
091
092   @Override /* ParserBuilder */
093   public JsonParserBuilder autoCloseStreams(boolean value) {
094      super.autoCloseStreams(value);
095      return this;
096   }
097
098   @Override /* ParserBuilder */
099   public JsonParserBuilder autoCloseStreams() {
100      super.autoCloseStreams();
101      return this;
102   }
103
104   @Override /* ParserBuilder */
105   public JsonParserBuilder fileCharset(String value) {
106      super.fileCharset(value);
107      return this;
108   }
109
110   @Override /* ParserBuilder */
111   public JsonParserBuilder inputStreamCharset(String value) {
112      super.inputStreamCharset(value);
113      return this;
114   }
115
116   @Override /* ParserBuilder */
117   public JsonParserBuilder listener(Class<? extends ParserListener> value) {
118      super.listener(value);
119      return this;
120   }
121
122   @Override /* ParserBuilder */
123   public JsonParserBuilder strict(boolean value) {
124      super.strict(value);
125      return this;
126   }
127
128   @Override /* ParserBuilder */
129   public JsonParserBuilder strict() {
130      super.strict();
131      return this;
132   }
133
134   @Override /* ParserBuilder */
135   public JsonParserBuilder trimStrings(boolean value) {
136      super.trimStrings(value);
137      return this;
138   }
139
140   @Override /* ParserBuilder */
141   public JsonParserBuilder trimStrings() {
142      super.trimStrings();
143      return this;
144   }
145
146   @Override /* ParserBuilder */
147   public JsonParserBuilder unbuffered(boolean value) {
148      super.unbuffered(value);
149      return this;
150   }
151
152   @Override /* ParserBuilder */
153   public JsonParserBuilder unbuffered() {
154      super.unbuffered();
155      return this;
156   }
157
158   @Override /* BeanContextBuilder */
159   public JsonParserBuilder beansRequireDefaultConstructor(boolean value) {
160      super.beansRequireDefaultConstructor(value);
161      return this;
162   }
163
164   @Override /* BeanContextBuilder */
165   public JsonParserBuilder beansRequireDefaultConstructor() {
166      super.beansRequireDefaultConstructor();
167      return this;
168   }
169
170   @Override /* BeanContextBuilder */
171   public JsonParserBuilder beansRequireSerializable(boolean value) {
172      super.beansRequireSerializable(value);
173      return this;
174   }
175
176   @Override /* BeanContextBuilder */
177   public JsonParserBuilder beansRequireSerializable() {
178      super.beansRequireSerializable();
179      return this;
180   }
181
182   @Override /* BeanContextBuilder */
183   public JsonParserBuilder beansRequireSettersForGetters(boolean value) {
184      super.beansRequireSettersForGetters(value);
185      return this;
186   }
187
188   @Override /* BeanContextBuilder */
189   public JsonParserBuilder beansRequireSettersForGetters() {
190      super.beansRequireSettersForGetters();
191      return this;
192   }
193
194   @Override /* BeanContextBuilder */
195   public JsonParserBuilder beansRequireSomeProperties(boolean value) {
196      super.beansRequireSomeProperties(value);
197      return this;
198   }
199
200   @Override /* BeanContextBuilder */
201   public JsonParserBuilder beanMapPutReturnsOldValue(boolean value) {
202      super.beanMapPutReturnsOldValue(value);
203      return this;
204   }
205
206   @Override /* BeanContextBuilder */
207   public JsonParserBuilder beanMapPutReturnsOldValue() {
208      super.beanMapPutReturnsOldValue();
209      return this;
210   }
211
212   @Override /* BeanContextBuilder */
213   public JsonParserBuilder beanConstructorVisibility(Visibility value) {
214      super.beanConstructorVisibility(value);
215      return this;
216   }
217
218   @Override /* BeanContextBuilder */
219   public JsonParserBuilder beanClassVisibility(Visibility value) {
220      super.beanClassVisibility(value);
221      return this;
222   }
223
224   @Override /* BeanContextBuilder */
225   public JsonParserBuilder beanFieldVisibility(Visibility value) {
226      super.beanFieldVisibility(value);
227      return this;
228   }
229
230   @Override /* BeanContextBuilder */
231   public JsonParserBuilder beanMethodVisibility(Visibility value) {
232      super.beanMethodVisibility(value);
233      return this;
234   }
235
236   @Override /* BeanContextBuilder */
237   public JsonParserBuilder useJavaBeanIntrospector(boolean value) {
238      super.useJavaBeanIntrospector(value);
239      return this;
240   }
241
242   @Override /* BeanContextBuilder */
243   public JsonParserBuilder useJavaBeanIntrospector() {
244      super.useJavaBeanIntrospector();
245      return this;
246   }
247
248   @Override /* BeanContextBuilder */
249   public JsonParserBuilder useInterfaceProxies(boolean value) {
250      super.useInterfaceProxies(value);
251      return this;
252   }
253
254   @Override /* BeanContextBuilder */
255   public JsonParserBuilder ignoreUnknownBeanProperties(boolean value) {
256      super.ignoreUnknownBeanProperties(value);
257      return this;
258   }
259
260   @Override /* BeanContextBuilder */
261   public JsonParserBuilder ignoreUnknownBeanProperties() {
262      super.ignoreUnknownBeanProperties();
263      return this;
264   }
265
266   @Override /* BeanContextBuilder */
267   public JsonParserBuilder ignoreUnknownNullBeanProperties(boolean value) {
268      super.ignoreUnknownNullBeanProperties(value);
269      return this;
270   }
271
272   @Override /* BeanContextBuilder */
273   public JsonParserBuilder ignorePropertiesWithoutSetters(boolean value) {
274      super.ignorePropertiesWithoutSetters(value);
275      return this;
276   }
277
278   @Override /* BeanContextBuilder */
279   public JsonParserBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
280      super.ignoreInvocationExceptionsOnGetters(value);
281      return this;
282   }
283
284   @Override /* BeanContextBuilder */
285   public JsonParserBuilder ignoreInvocationExceptionsOnGetters() {
286      super.ignoreInvocationExceptionsOnGetters();
287      return this;
288   }
289
290   @Override /* BeanContextBuilder */
291   public JsonParserBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
292      super.ignoreInvocationExceptionsOnSetters(value);
293      return this;
294   }
295
296   @Override /* BeanContextBuilder */
297   public JsonParserBuilder ignoreInvocationExceptionsOnSetters() {
298      super.ignoreInvocationExceptionsOnSetters();
299      return this;
300   }
301
302   @Override /* BeanContextBuilder */
303   public JsonParserBuilder sortProperties(boolean value) {
304      super.sortProperties(value);
305      return this;
306   }
307
308   @Override /* BeanContextBuilder */
309   public JsonParserBuilder sortProperties() {
310      super.sortProperties();
311      return this;
312   }
313
314   @Override /* BeanContextBuilder */
315   public JsonParserBuilder notBeanPackages(Object...values) {
316      super.notBeanPackages(values);
317      return this;
318   }
319
320   @Override /* BeanContextBuilder */
321   public JsonParserBuilder notBeanPackages(String...values) {
322      super.notBeanPackages(values);
323      return this;
324   }
325
326   @Override /* BeanContextBuilder */
327   public JsonParserBuilder notBeanPackages(boolean append, Object...values) {
328      super.notBeanPackages(append, values);
329      return this;
330   }
331
332   @Override /* BeanContextBuilder */
333   public JsonParserBuilder notBeanPackagesRemove(Object...values) {
334      super.notBeanPackagesRemove(values);
335      return this;
336   }
337
338   @Override /* BeanContextBuilder */
339   public JsonParserBuilder notBeanClasses(Object...values) {
340      super.notBeanClasses(values);
341      return this;
342   }
343
344   @Override /* BeanContextBuilder */
345   public JsonParserBuilder notBeanClasses(Class<?>...values) {
346      super.notBeanClasses(values);
347      return this;
348   }
349
350   @Override /* BeanContextBuilder */
351   public JsonParserBuilder notBeanClasses(boolean append, Object...values) {
352      super.notBeanClasses(append, values);
353      return this;
354   }
355
356   @Override /* BeanContextBuilder */
357   public JsonParserBuilder notBeanClassesRemove(Object...values) {
358      super.notBeanClassesRemove(values);
359      return this;
360   }
361
362   @Override /* BeanContextBuilder */
363   public JsonParserBuilder beanFilters(Object...values) {
364      super.beanFilters(values);
365      return this;
366   }
367
368   @Override /* BeanContextBuilder */
369   public JsonParserBuilder beanFilters(Class<?>...values) {
370      super.beanFilters(values);
371      return this;
372   }
373
374   @Override /* BeanContextBuilder */
375   public JsonParserBuilder beanFilters(boolean append, Object...values) {
376      super.beanFilters(append, values);
377      return this;
378   }
379
380   @Override /* BeanContextBuilder */
381   public JsonParserBuilder beanFiltersRemove(Object...values) {
382      super.beanFiltersRemove(values);
383      return this;
384   }
385
386   @Override /* BeanContextBuilder */
387   public JsonParserBuilder pojoSwaps(Object...values) {
388      super.pojoSwaps(values);
389      return this;
390   }
391
392   @Override /* BeanContextBuilder */
393   public JsonParserBuilder pojoSwaps(Class<?>...values) {
394      super.pojoSwaps(values);
395      return this;
396   }
397
398   @Override /* BeanContextBuilder */
399   public JsonParserBuilder pojoSwaps(boolean append, Object...values) {
400      super.pojoSwaps(append, values);
401      return this;
402   }
403
404   @Override /* BeanContextBuilder */
405   public JsonParserBuilder pojoSwapsRemove(Object...values) {
406      super.pojoSwapsRemove(values);
407      return this;
408   }
409
410   @Override /* BeanContextBuilder */
411   public JsonParserBuilder implClasses(Map<String,Class<?>> values) {
412      super.implClasses(values);
413      return this;
414   }
415
416   @Override /* BeanContextBuilder */
417   public <T> JsonParserBuilder implClass(Class<T> interfaceClass, Class<? extends T> implClass) {
418      super.implClass(interfaceClass, implClass);
419      return this;
420   }
421
422   @Override /* BeanContextBuilder */
423   public JsonParserBuilder beanDictionary(Object...values) {
424      super.beanDictionary(values);
425      return this;
426   }
427
428   @Override /* BeanContextBuilder */
429   public JsonParserBuilder beanDictionary(Class<?>...values) {
430      super.beanDictionary(values);
431      return this;
432   }
433
434   @Override /* BeanContextBuilder */
435   public JsonParserBuilder beanDictionary(boolean append, Object...values) {
436      super.beanDictionary(append, values);
437      return this;
438   }
439
440   @Override /* BeanContextBuilder */
441   public JsonParserBuilder beanDictionaryRemove(Object...values) {
442      super.beanDictionaryRemove(values);
443      return this;
444   }
445
446   @Override /* BeanContextBuilder */
447   public JsonParserBuilder beanTypePropertyName(String value) {
448      super.beanTypePropertyName(value);
449      return this;
450   }
451
452   @Override /* BeanContextBuilder */
453   public JsonParserBuilder locale(Locale value) {
454      super.locale(value);
455      return this;
456   }
457
458   @Override /* BeanContextBuilder */
459   public JsonParserBuilder timeZone(TimeZone value) {
460      super.timeZone(value);
461      return this;
462   }
463
464   @Override /* BeanContextBuilder */
465   public JsonParserBuilder mediaType(MediaType value) {
466      super.mediaType(value);
467      return this;
468   }
469
470   @Override /* BeanContextBuilder */
471   public JsonParserBuilder debug() {
472      super.debug();
473      return this;
474   }
475
476   @Override /* ContextBuilder */
477   public JsonParserBuilder set(String name, Object value) {
478      super.set(name, value);
479      return this;
480   }
481
482   @Override /* ContextBuilder */
483   public JsonParserBuilder set(boolean append, String name, Object value) {
484      super.set(append, name, value);
485      return this;
486   }
487
488   @Override /* ContextBuilder */
489   public JsonParserBuilder set(Map<String,Object> properties) {
490      super.set(properties);
491      return this;
492   }
493
494   @Override /* ContextBuilder */
495   public JsonParserBuilder add(Map<String,Object> properties) {
496      super.add(properties);
497      return this;
498   }
499
500   @Override /* ContextBuilder */
501   public JsonParserBuilder addTo(String name, Object value) {
502      super.addTo(name, value);
503      return this;
504   }
505
506   @Override /* ContextBuilder */
507   public JsonParserBuilder addTo(String name, String key, Object value) {
508      super.addTo(name, key, value);
509      return this;
510   }
511
512   @Override /* ContextBuilder */
513   public JsonParserBuilder removeFrom(String name, Object value) {
514      super.removeFrom(name, value);
515      return this;
516   }
517
518   @Override /* ContextBuilder */
519   public JsonParserBuilder apply(PropertyStore copyFrom) {
520      super.apply(copyFrom);
521      return this;
522   }
523}