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.soap;
014
015import static org.apache.juneau.soap.SoapXmlSerializer.*;
016
017import java.lang.annotation.*;
018import java.lang.reflect.*;
019import java.nio.charset.*;
020import java.util.*;
021
022import org.apache.juneau.*;
023import org.apache.juneau.http.*;
024import org.apache.juneau.internal.*;
025import org.apache.juneau.reflect.*;
026import org.apache.juneau.svl.*;
027import org.apache.juneau.xml.*;
028
029/**
030 * Builder class for building instances of soap/xml serializers.
031 */
032public class SoapXmlSerializerBuilder extends XmlSerializerBuilder {
033
034   /**
035    * Constructor, default settings.
036    */
037   public SoapXmlSerializerBuilder() {
038      super();
039   }
040
041   /**
042    * Constructor.
043    *
044    * @param ps The initial configuration settings for this builder.
045    */
046   public SoapXmlSerializerBuilder(PropertyStore ps) {
047      super(ps);
048   }
049
050   @Override /* ContextBuilder */
051   public SoapXmlSerializer build() {
052      return build(SoapXmlSerializer.class);
053   }
054
055   //-----------------------------------------------------------------------------------------------------------------
056   // Properties
057   //-----------------------------------------------------------------------------------------------------------------
058
059   /**
060    * <i><l>SoapXmlSerializer</l> configuration property:&emsp;</i>  The <c>SOAPAction</c> HTTP header value to set on responses.
061    *
062    * <ul class='seealso'>
063    *    <li class='jf'>{@link SoapXmlSerializer#SOAPXML_SOAPAction}
064    * </ul>
065    *
066    * @param value
067    *    The new value for this property.
068    *    <br>The default is <js>"http://www.w3.org/2003/05/soap-envelope"</js>.
069    * @return This object (for method chaining).
070    */
071   @FluentSetter
072   public SoapXmlSerializerBuilder soapAction(String value) {
073      return set(SOAPXML_SOAPAction, value);
074   }
075
076   // <FluentSetters>
077
078   @Override /* GENERATED - ContextBuilder */
079   public SoapXmlSerializerBuilder add(Map<String,Object> properties) {
080      super.add(properties);
081      return this;
082   }
083
084   @Override /* GENERATED - ContextBuilder */
085   public SoapXmlSerializerBuilder addTo(String name, Object value) {
086      super.addTo(name, value);
087      return this;
088   }
089
090   @Override /* GENERATED - ContextBuilder */
091   public SoapXmlSerializerBuilder appendTo(String name, Object value) {
092      super.appendTo(name, value);
093      return this;
094   }
095
096   @Override /* GENERATED - ContextBuilder */
097   public SoapXmlSerializerBuilder apply(PropertyStore copyFrom) {
098      super.apply(copyFrom);
099      return this;
100   }
101
102   @Override /* GENERATED - ContextBuilder */
103   public SoapXmlSerializerBuilder applyAnnotations(java.lang.Class<?>...fromClasses) {
104      super.applyAnnotations(fromClasses);
105      return this;
106   }
107
108   @Override /* GENERATED - ContextBuilder */
109   public SoapXmlSerializerBuilder applyAnnotations(Method...fromMethods) {
110      super.applyAnnotations(fromMethods);
111      return this;
112   }
113
114   @Override /* GENERATED - ContextBuilder */
115   public SoapXmlSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession r) {
116      super.applyAnnotations(al, r);
117      return this;
118   }
119
120   @Override /* GENERATED - ContextBuilder */
121   public SoapXmlSerializerBuilder debug() {
122      super.debug();
123      return this;
124   }
125
126   @Override /* GENERATED - ContextBuilder */
127   public SoapXmlSerializerBuilder locale(Locale value) {
128      super.locale(value);
129      return this;
130   }
131
132   @Override /* GENERATED - ContextBuilder */
133   public SoapXmlSerializerBuilder mediaType(MediaType value) {
134      super.mediaType(value);
135      return this;
136   }
137
138   @Override /* GENERATED - ContextBuilder */
139   public SoapXmlSerializerBuilder prependTo(String name, Object value) {
140      super.prependTo(name, value);
141      return this;
142   }
143
144   @Override /* GENERATED - ContextBuilder */
145   public SoapXmlSerializerBuilder putAllTo(String name, Object value) {
146      super.putAllTo(name, value);
147      return this;
148   }
149
150   @Override /* GENERATED - ContextBuilder */
151   public SoapXmlSerializerBuilder putTo(String name, String key, Object value) {
152      super.putTo(name, key, value);
153      return this;
154   }
155
156   @Override /* GENERATED - ContextBuilder */
157   public SoapXmlSerializerBuilder removeFrom(String name, Object value) {
158      super.removeFrom(name, value);
159      return this;
160   }
161
162   @Override /* GENERATED - ContextBuilder */
163   public SoapXmlSerializerBuilder set(Map<String,Object> properties) {
164      super.set(properties);
165      return this;
166   }
167
168   @Override /* GENERATED - ContextBuilder */
169   public SoapXmlSerializerBuilder set(String name, Object value) {
170      super.set(name, value);
171      return this;
172   }
173
174   @Override /* GENERATED - ContextBuilder */
175   public SoapXmlSerializerBuilder timeZone(TimeZone value) {
176      super.timeZone(value);
177      return this;
178   }
179
180   @Override /* GENERATED - BeanContextBuilder */
181   public SoapXmlSerializerBuilder annotations(Annotation...values) {
182      super.annotations(values);
183      return this;
184   }
185
186   @Override /* GENERATED - BeanContextBuilder */
187   public SoapXmlSerializerBuilder beanClassVisibility(Visibility value) {
188      super.beanClassVisibility(value);
189      return this;
190   }
191
192   @Override /* GENERATED - BeanContextBuilder */
193   public SoapXmlSerializerBuilder beanConstructorVisibility(Visibility value) {
194      super.beanConstructorVisibility(value);
195      return this;
196   }
197
198   @Override /* GENERATED - BeanContextBuilder */
199   public SoapXmlSerializerBuilder beanFieldVisibility(Visibility value) {
200      super.beanFieldVisibility(value);
201      return this;
202   }
203
204   @Override /* GENERATED - BeanContextBuilder */
205   public SoapXmlSerializerBuilder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.transform.BeanInterceptor<?>> value) {
206      super.beanInterceptor(on, value);
207      return this;
208   }
209
210   @Override /* GENERATED - BeanContextBuilder */
211   public SoapXmlSerializerBuilder beanMapPutReturnsOldValue() {
212      super.beanMapPutReturnsOldValue();
213      return this;
214   }
215
216   @Override /* GENERATED - BeanContextBuilder */
217   public SoapXmlSerializerBuilder beanMethodVisibility(Visibility value) {
218      super.beanMethodVisibility(value);
219      return this;
220   }
221
222   @Override /* GENERATED - BeanContextBuilder */
223   public SoapXmlSerializerBuilder beansDontRequireSomeProperties() {
224      super.beansDontRequireSomeProperties();
225      return this;
226   }
227
228   @Override /* GENERATED - BeanContextBuilder */
229   public SoapXmlSerializerBuilder beansRequireDefaultConstructor() {
230      super.beansRequireDefaultConstructor();
231      return this;
232   }
233
234   @Override /* GENERATED - BeanContextBuilder */
235   public SoapXmlSerializerBuilder beansRequireSerializable() {
236      super.beansRequireSerializable();
237      return this;
238   }
239
240   @Override /* GENERATED - BeanContextBuilder */
241   public SoapXmlSerializerBuilder beansRequireSettersForGetters() {
242      super.beansRequireSettersForGetters();
243      return this;
244   }
245
246   @Override /* GENERATED - BeanContextBuilder */
247   public SoapXmlSerializerBuilder bpi(Map<String,Object> values) {
248      super.bpi(values);
249      return this;
250   }
251
252   @Override /* GENERATED - BeanContextBuilder */
253   public SoapXmlSerializerBuilder bpi(Class<?> beanClass, String properties) {
254      super.bpi(beanClass, properties);
255      return this;
256   }
257
258   @Override /* GENERATED - BeanContextBuilder */
259   public SoapXmlSerializerBuilder bpi(String beanClassName, String properties) {
260      super.bpi(beanClassName, properties);
261      return this;
262   }
263
264   @Override /* GENERATED - BeanContextBuilder */
265   public SoapXmlSerializerBuilder bpro(Map<String,Object> values) {
266      super.bpro(values);
267      return this;
268   }
269
270   @Override /* GENERATED - BeanContextBuilder */
271   public SoapXmlSerializerBuilder bpro(Class<?> beanClass, String properties) {
272      super.bpro(beanClass, properties);
273      return this;
274   }
275
276   @Override /* GENERATED - BeanContextBuilder */
277   public SoapXmlSerializerBuilder bpro(String beanClassName, String properties) {
278      super.bpro(beanClassName, properties);
279      return this;
280   }
281
282   @Override /* GENERATED - BeanContextBuilder */
283   public SoapXmlSerializerBuilder bpwo(Map<String,Object> values) {
284      super.bpwo(values);
285      return this;
286   }
287
288   @Override /* GENERATED - BeanContextBuilder */
289   public SoapXmlSerializerBuilder bpwo(Class<?> beanClass, String properties) {
290      super.bpwo(beanClass, properties);
291      return this;
292   }
293
294   @Override /* GENERATED - BeanContextBuilder */
295   public SoapXmlSerializerBuilder bpwo(String beanClassName, String properties) {
296      super.bpwo(beanClassName, properties);
297      return this;
298   }
299
300   @Override /* GENERATED - BeanContextBuilder */
301   public SoapXmlSerializerBuilder bpx(Map<String,Object> values) {
302      super.bpx(values);
303      return this;
304   }
305
306   @Override /* GENERATED - BeanContextBuilder */
307   public SoapXmlSerializerBuilder bpx(Class<?> beanClass, String properties) {
308      super.bpx(beanClass, properties);
309      return this;
310   }
311
312   @Override /* GENERATED - BeanContextBuilder */
313   public SoapXmlSerializerBuilder bpx(String beanClassName, String properties) {
314      super.bpx(beanClassName, properties);
315      return this;
316   }
317
318   @Override /* GENERATED - BeanContextBuilder */
319   public SoapXmlSerializerBuilder dictionary(Object...values) {
320      super.dictionary(values);
321      return this;
322   }
323
324   @Override /* GENERATED - BeanContextBuilder */
325   public SoapXmlSerializerBuilder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
326      super.dictionaryOn(on, values);
327      return this;
328   }
329
330   @Override /* GENERATED - BeanContextBuilder */
331   public SoapXmlSerializerBuilder dontIgnorePropertiesWithoutSetters() {
332      super.dontIgnorePropertiesWithoutSetters();
333      return this;
334   }
335
336   @Override /* GENERATED - BeanContextBuilder */
337   public SoapXmlSerializerBuilder dontIgnoreTransientFields() {
338      super.dontIgnoreTransientFields();
339      return this;
340   }
341
342   @Override /* GENERATED - BeanContextBuilder */
343   public SoapXmlSerializerBuilder dontIgnoreUnknownNullBeanProperties() {
344      super.dontIgnoreUnknownNullBeanProperties();
345      return this;
346   }
347
348   @Override /* GENERATED - BeanContextBuilder */
349   public SoapXmlSerializerBuilder dontUseInterfaceProxies() {
350      super.dontUseInterfaceProxies();
351      return this;
352   }
353
354   @Override /* GENERATED - BeanContextBuilder */
355   public <T> SoapXmlSerializerBuilder example(Class<T> pojoClass, T o) {
356      super.example(pojoClass, o);
357      return this;
358   }
359
360   @Override /* GENERATED - BeanContextBuilder */
361   public <T> SoapXmlSerializerBuilder exampleJson(Class<T> pojoClass, String json) {
362      super.exampleJson(pojoClass, json);
363      return this;
364   }
365
366   @Override /* GENERATED - BeanContextBuilder */
367   public SoapXmlSerializerBuilder fluentSetters() {
368      super.fluentSetters();
369      return this;
370   }
371
372   @Override /* GENERATED - BeanContextBuilder */
373   public SoapXmlSerializerBuilder fluentSetters(Class<?> on) {
374      super.fluentSetters(on);
375      return this;
376   }
377
378   @Override /* GENERATED - BeanContextBuilder */
379   public SoapXmlSerializerBuilder ignoreInvocationExceptionsOnGetters() {
380      super.ignoreInvocationExceptionsOnGetters();
381      return this;
382   }
383
384   @Override /* GENERATED - BeanContextBuilder */
385   public SoapXmlSerializerBuilder ignoreInvocationExceptionsOnSetters() {
386      super.ignoreInvocationExceptionsOnSetters();
387      return this;
388   }
389
390   @Override /* GENERATED - BeanContextBuilder */
391   public SoapXmlSerializerBuilder ignoreUnknownBeanProperties() {
392      super.ignoreUnknownBeanProperties();
393      return this;
394   }
395
396   @Override /* GENERATED - BeanContextBuilder */
397   public SoapXmlSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
398      super.implClass(interfaceClass, implClass);
399      return this;
400   }
401
402   @Override /* GENERATED - BeanContextBuilder */
403   public SoapXmlSerializerBuilder implClasses(Map<Class<?>,Class<?>> values) {
404      super.implClasses(values);
405      return this;
406   }
407
408   @Override /* GENERATED - BeanContextBuilder */
409   public SoapXmlSerializerBuilder interfaceClass(Class<?> on, Class<?> value) {
410      super.interfaceClass(on, value);
411      return this;
412   }
413
414   @Override /* GENERATED - BeanContextBuilder */
415   public SoapXmlSerializerBuilder interfaces(java.lang.Class<?>...value) {
416      super.interfaces(value);
417      return this;
418   }
419
420   @Override /* GENERATED - BeanContextBuilder */
421   public SoapXmlSerializerBuilder notBeanClasses(Object...values) {
422      super.notBeanClasses(values);
423      return this;
424   }
425
426   @Override /* GENERATED - BeanContextBuilder */
427   public SoapXmlSerializerBuilder notBeanPackages(Object...values) {
428      super.notBeanPackages(values);
429      return this;
430   }
431
432   @Override /* GENERATED - BeanContextBuilder */
433   public SoapXmlSerializerBuilder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
434      super.propertyNamer(value);
435      return this;
436   }
437
438   @Override /* GENERATED - BeanContextBuilder */
439   public SoapXmlSerializerBuilder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
440      super.propertyNamer(on, value);
441      return this;
442   }
443
444   @Override /* GENERATED - BeanContextBuilder */
445   public SoapXmlSerializerBuilder sortProperties() {
446      super.sortProperties();
447      return this;
448   }
449
450   @Override /* GENERATED - BeanContextBuilder */
451   public SoapXmlSerializerBuilder sortProperties(java.lang.Class<?>...on) {
452      super.sortProperties(on);
453      return this;
454   }
455
456   @Override /* GENERATED - BeanContextBuilder */
457   public SoapXmlSerializerBuilder stopClass(Class<?> on, Class<?> value) {
458      super.stopClass(on, value);
459      return this;
460   }
461
462   @Override /* GENERATED - BeanContextBuilder */
463   public SoapXmlSerializerBuilder swaps(Object...values) {
464      super.swaps(values);
465      return this;
466   }
467
468   @Override /* GENERATED - BeanContextBuilder */
469   public SoapXmlSerializerBuilder typeName(Class<?> on, String value) {
470      super.typeName(on, value);
471      return this;
472   }
473
474   @Override /* GENERATED - BeanContextBuilder */
475   public SoapXmlSerializerBuilder typePropertyName(String value) {
476      super.typePropertyName(value);
477      return this;
478   }
479
480   @Override /* GENERATED - BeanContextBuilder */
481   public SoapXmlSerializerBuilder typePropertyName(Class<?> on, String value) {
482      super.typePropertyName(on, value);
483      return this;
484   }
485
486   @Override /* GENERATED - BeanContextBuilder */
487   public SoapXmlSerializerBuilder useEnumNames() {
488      super.useEnumNames();
489      return this;
490   }
491
492   @Override /* GENERATED - BeanContextBuilder */
493   public SoapXmlSerializerBuilder useJavaBeanIntrospector() {
494      super.useJavaBeanIntrospector();
495      return this;
496   }
497
498   @Override /* GENERATED - BeanTraverseBuilder */
499   public SoapXmlSerializerBuilder detectRecursions() {
500      super.detectRecursions();
501      return this;
502   }
503
504   @Override /* GENERATED - BeanTraverseBuilder */
505   public SoapXmlSerializerBuilder ignoreRecursions() {
506      super.ignoreRecursions();
507      return this;
508   }
509
510   @Override /* GENERATED - BeanTraverseBuilder */
511   public SoapXmlSerializerBuilder initialDepth(int value) {
512      super.initialDepth(value);
513      return this;
514   }
515
516   @Override /* GENERATED - BeanTraverseBuilder */
517   public SoapXmlSerializerBuilder maxDepth(int value) {
518      super.maxDepth(value);
519      return this;
520   }
521
522   @Override /* GENERATED - SerializerBuilder */
523   public SoapXmlSerializerBuilder addBeanTypes() {
524      super.addBeanTypes();
525      return this;
526   }
527
528   @Override /* GENERATED - SerializerBuilder */
529   public SoapXmlSerializerBuilder addRootType() {
530      super.addRootType();
531      return this;
532   }
533
534   @Override /* GENERATED - SerializerBuilder */
535   public SoapXmlSerializerBuilder keepNullProperties() {
536      super.keepNullProperties();
537      return this;
538   }
539
540   @Override /* GENERATED - SerializerBuilder */
541   public SoapXmlSerializerBuilder listener(Class<? extends org.apache.juneau.serializer.SerializerListener> value) {
542      super.listener(value);
543      return this;
544   }
545
546   @Override /* GENERATED - SerializerBuilder */
547   public SoapXmlSerializerBuilder sortCollections() {
548      super.sortCollections();
549      return this;
550   }
551
552   @Override /* GENERATED - SerializerBuilder */
553   public SoapXmlSerializerBuilder sortMaps() {
554      super.sortMaps();
555      return this;
556   }
557
558   @Override /* GENERATED - SerializerBuilder */
559   public SoapXmlSerializerBuilder trimEmptyCollections() {
560      super.trimEmptyCollections();
561      return this;
562   }
563
564   @Override /* GENERATED - SerializerBuilder */
565   public SoapXmlSerializerBuilder trimEmptyMaps() {
566      super.trimEmptyMaps();
567      return this;
568   }
569
570   @Override /* GENERATED - SerializerBuilder */
571   public SoapXmlSerializerBuilder trimStrings() {
572      super.trimStrings();
573      return this;
574   }
575
576   @Override /* GENERATED - SerializerBuilder */
577   public SoapXmlSerializerBuilder uriContext(UriContext value) {
578      super.uriContext(value);
579      return this;
580   }
581
582   @Override /* GENERATED - SerializerBuilder */
583   public SoapXmlSerializerBuilder uriRelativity(UriRelativity value) {
584      super.uriRelativity(value);
585      return this;
586   }
587
588   @Override /* GENERATED - SerializerBuilder */
589   public SoapXmlSerializerBuilder uriResolution(UriResolution value) {
590      super.uriResolution(value);
591      return this;
592   }
593
594   @Override /* GENERATED - WriterSerializerBuilder */
595   public SoapXmlSerializerBuilder fileCharset(Charset value) {
596      super.fileCharset(value);
597      return this;
598   }
599
600   @Override /* GENERATED - WriterSerializerBuilder */
601   public SoapXmlSerializerBuilder maxIndent(int value) {
602      super.maxIndent(value);
603      return this;
604   }
605
606   @Override /* GENERATED - WriterSerializerBuilder */
607   public SoapXmlSerializerBuilder quoteChar(char value) {
608      super.quoteChar(value);
609      return this;
610   }
611
612   @Override /* GENERATED - WriterSerializerBuilder */
613   public SoapXmlSerializerBuilder sq() {
614      super.sq();
615      return this;
616   }
617
618   @Override /* GENERATED - WriterSerializerBuilder */
619   public SoapXmlSerializerBuilder streamCharset(Charset value) {
620      super.streamCharset(value);
621      return this;
622   }
623
624   @Override /* GENERATED - WriterSerializerBuilder */
625   public SoapXmlSerializerBuilder useWhitespace() {
626      super.useWhitespace();
627      return this;
628   }
629
630   @Override /* GENERATED - WriterSerializerBuilder */
631   public SoapXmlSerializerBuilder ws() {
632      super.ws();
633      return this;
634   }
635
636   @Override /* GENERATED - XmlSerializerBuilder */
637   public SoapXmlSerializerBuilder addNamespaceUrisToRoot() {
638      super.addNamespaceUrisToRoot();
639      return this;
640   }
641
642   @Override /* GENERATED - XmlSerializerBuilder */
643   public SoapXmlSerializerBuilder defaultNamespace(String value) {
644      super.defaultNamespace(value);
645      return this;
646   }
647
648   @Override /* GENERATED - XmlSerializerBuilder */
649   public SoapXmlSerializerBuilder dontAutoDetectNamespaces() {
650      super.dontAutoDetectNamespaces();
651      return this;
652   }
653
654   @Override /* GENERATED - XmlSerializerBuilder */
655   public SoapXmlSerializerBuilder enableNamespaces() {
656      super.enableNamespaces();
657      return this;
658   }
659
660   @Override /* GENERATED - XmlSerializerBuilder */
661   public SoapXmlSerializerBuilder namespaces(String...values) {
662      super.namespaces(values);
663      return this;
664   }
665
666   @Override /* GENERATED - XmlSerializerBuilder */
667   public SoapXmlSerializerBuilder namespaces(Namespace...values) {
668      super.namespaces(values);
669      return this;
670   }
671
672   @Override /* GENERATED - XmlSerializerBuilder */
673   public SoapXmlSerializerBuilder ns() {
674      super.ns();
675      return this;
676   }
677
678   // </FluentSetters>
679}