blob: 9b928e47716d3c9dece62b680282a88f0f4e5895 [file] [log] [blame]
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.urlencoding;
import static org.apache.juneau.urlencoding.UrlEncodingSerializer.*;
import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.http.header.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.reflect.*;
import org.apache.juneau.svl.*;
import org.apache.juneau.uon.*;
/**
* Builder class for building instances of URL-Encoding serializers.
*/
@FluentSetters
public class UrlEncodingSerializerBuilder extends UonSerializerBuilder {
/**
* Constructor, default settings.
*/
public UrlEncodingSerializerBuilder() {
super();
}
/**
* Copy constructor.
*
* @param copyFrom The bean to copy from.
*/
public UrlEncodingSerializerBuilder(UrlEncodingSerializer copyFrom) {
super(copyFrom);
}
@Override /* ContextBuilder */
public UrlEncodingSerializer build() {
return build(UrlEncodingSerializer.class);
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* <i><l>UrlEncodingSerializer</l> configuration property:&emsp;</i> Serialize bean property collections/arrays as separate key/value pairs.
*
* <p>
* Shortcut for calling <code>expandedParams(<jk>true</jk>)</code>.
*
* <ul class='seealso'>
* <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}
* </ul>
*
* @return This object (for method chaining).
*/
@FluentSetter
public UrlEncodingSerializerBuilder expandedParams() {
return set(URLENC_expandedParams);
}
// <FluentSetters>
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder add(Map<String,Object> properties) {
super.add(properties);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder addTo(String name, Object value) {
super.addTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder appendTo(String name, Object value) {
super.appendTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder apply(ContextProperties copyFrom) {
super.apply(copyFrom);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder applyAnnotations(java.lang.Class<?>...fromClasses) {
super.applyAnnotations(fromClasses);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder applyAnnotations(Method...fromMethods) {
super.applyAnnotations(fromMethods);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession r) {
super.applyAnnotations(al, r);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder debug() {
super.debug();
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder locale(Locale value) {
super.locale(value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder mediaType(MediaType value) {
super.mediaType(value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder prependTo(String name, Object value) {
super.prependTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder putAllTo(String name, Object value) {
super.putAllTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder putTo(String name, String key, Object value) {
super.putTo(name, key, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder removeFrom(String name, Object value) {
super.removeFrom(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder set(String name) {
super.set(name);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder set(Map<String,Object> properties) {
super.set(properties);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder set(String name, Object value) {
super.set(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder timeZone(TimeZone value) {
super.timeZone(value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public UrlEncodingSerializerBuilder unset(String name) {
super.unset(name);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder annotations(Annotation...values) {
super.annotations(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanClassVisibility(Visibility value) {
super.beanClassVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanConstructorVisibility(Visibility value) {
super.beanConstructorVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanFieldVisibility(Visibility value) {
super.beanFieldVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.transform.BeanInterceptor<?>> value) {
super.beanInterceptor(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanMapPutReturnsOldValue() {
super.beanMapPutReturnsOldValue();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanMethodVisibility(Visibility value) {
super.beanMethodVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanProperties(Map<String,Object> values) {
super.beanProperties(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanProperties(Class<?> beanClass, String properties) {
super.beanProperties(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanProperties(String beanClassName, String properties) {
super.beanProperties(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesExcludes(Map<String,Object> values) {
super.beanPropertiesExcludes(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesExcludes(Class<?> beanClass, String properties) {
super.beanPropertiesExcludes(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesExcludes(String beanClassName, String properties) {
super.beanPropertiesExcludes(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesReadOnly(Map<String,Object> values) {
super.beanPropertiesReadOnly(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesReadOnly(Class<?> beanClass, String properties) {
super.beanPropertiesReadOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesReadOnly(String beanClassName, String properties) {
super.beanPropertiesReadOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesWriteOnly(Map<String,Object> values) {
super.beanPropertiesWriteOnly(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesWriteOnly(Class<?> beanClass, String properties) {
super.beanPropertiesWriteOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beanPropertiesWriteOnly(String beanClassName, String properties) {
super.beanPropertiesWriteOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beansRequireDefaultConstructor() {
super.beansRequireDefaultConstructor();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beansRequireSerializable() {
super.beansRequireSerializable();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder beansRequireSettersForGetters() {
super.beansRequireSettersForGetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder dictionary(Object...values) {
super.dictionary(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
super.dictionaryOn(on, values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder disableBeansRequireSomeProperties() {
super.disableBeansRequireSomeProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder disableIgnoreMissingSetters() {
super.disableIgnoreMissingSetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder disableIgnoreTransientFields() {
super.disableIgnoreTransientFields();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder disableIgnoreUnknownNullBeanProperties() {
super.disableIgnoreUnknownNullBeanProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder disableInterfaceProxies() {
super.disableInterfaceProxies();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public <T> UrlEncodingSerializerBuilder example(Class<T> pojoClass, T o) {
super.example(pojoClass, o);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public <T> UrlEncodingSerializerBuilder example(Class<T> pojoClass, String json) {
super.example(pojoClass, json);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder findFluentSetters() {
super.findFluentSetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder findFluentSetters(Class<?> on) {
super.findFluentSetters(on);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder ignoreInvocationExceptionsOnGetters() {
super.ignoreInvocationExceptionsOnGetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder ignoreInvocationExceptionsOnSetters() {
super.ignoreInvocationExceptionsOnSetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder ignoreUnknownBeanProperties() {
super.ignoreUnknownBeanProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
super.implClass(interfaceClass, implClass);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder implClasses(Map<Class<?>,Class<?>> values) {
super.implClasses(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder interfaceClass(Class<?> on, Class<?> value) {
super.interfaceClass(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder interfaces(java.lang.Class<?>...value) {
super.interfaces(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder notBeanClasses(Object...values) {
super.notBeanClasses(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder notBeanPackages(Object...values) {
super.notBeanPackages(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
super.propertyNamer(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
super.propertyNamer(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder sortProperties() {
super.sortProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder sortProperties(java.lang.Class<?>...on) {
super.sortProperties(on);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder stopClass(Class<?> on, Class<?> value) {
super.stopClass(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder swaps(Object...values) {
super.swaps(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder typeName(Class<?> on, String value) {
super.typeName(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder typePropertyName(String value) {
super.typePropertyName(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder typePropertyName(Class<?> on, String value) {
super.typePropertyName(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder useEnumNames() {
super.useEnumNames();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public UrlEncodingSerializerBuilder useJavaBeanIntrospector() {
super.useJavaBeanIntrospector();
return this;
}
@Override /* GENERATED - BeanTraverseBuilder */
public UrlEncodingSerializerBuilder detectRecursions() {
super.detectRecursions();
return this;
}
@Override /* GENERATED - BeanTraverseBuilder */
public UrlEncodingSerializerBuilder ignoreRecursions() {
super.ignoreRecursions();
return this;
}
@Override /* GENERATED - BeanTraverseBuilder */
public UrlEncodingSerializerBuilder initialDepth(int value) {
super.initialDepth(value);
return this;
}
@Override /* GENERATED - BeanTraverseBuilder */
public UrlEncodingSerializerBuilder maxDepth(int value) {
super.maxDepth(value);
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder addBeanTypes() {
super.addBeanTypes();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder addRootType() {
super.addRootType();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder keepNullProperties() {
super.keepNullProperties();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder listener(Class<? extends org.apache.juneau.serializer.SerializerListener> value) {
super.listener(value);
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder sortCollections() {
super.sortCollections();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder sortMaps() {
super.sortMaps();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder trimEmptyCollections() {
super.trimEmptyCollections();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder trimEmptyMaps() {
super.trimEmptyMaps();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder trimStrings() {
super.trimStrings();
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder uriContext(UriContext value) {
super.uriContext(value);
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder uriRelativity(UriRelativity value) {
super.uriRelativity(value);
return this;
}
@Override /* GENERATED - SerializerBuilder */
public UrlEncodingSerializerBuilder uriResolution(UriResolution value) {
super.uriResolution(value);
return this;
}
@Override /* GENERATED - WriterSerializerBuilder */
public UrlEncodingSerializerBuilder fileCharset(Charset value) {
super.fileCharset(value);
return this;
}
@Override /* GENERATED - WriterSerializerBuilder */
public UrlEncodingSerializerBuilder maxIndent(int value) {
super.maxIndent(value);
return this;
}
@Override /* GENERATED - WriterSerializerBuilder */
public UrlEncodingSerializerBuilder quoteChar(char value) {
super.quoteChar(value);
return this;
}
@Override /* GENERATED - WriterSerializerBuilder */
public UrlEncodingSerializerBuilder sq() {
super.sq();
return this;
}
@Override /* GENERATED - WriterSerializerBuilder */
public UrlEncodingSerializerBuilder streamCharset(Charset value) {
super.streamCharset(value);
return this;
}
@Override /* GENERATED - WriterSerializerBuilder */
public UrlEncodingSerializerBuilder useWhitespace() {
super.useWhitespace();
return this;
}
@Override /* GENERATED - WriterSerializerBuilder */
public UrlEncodingSerializerBuilder ws() {
super.ws();
return this;
}
@Override /* GENERATED - UonSerializerBuilder */
public UrlEncodingSerializerBuilder encoding() {
super.encoding();
return this;
}
@Override /* GENERATED - UonSerializerBuilder */
public UrlEncodingSerializerBuilder encoding(boolean value) {
super.encoding(value);
return this;
}
@Override /* GENERATED - UonSerializerBuilder */
public UrlEncodingSerializerBuilder paramFormat(ParamFormat value) {
super.paramFormat(value);
return this;
}
@Override /* GENERATED - UonSerializerBuilder */
public UrlEncodingSerializerBuilder paramFormatPlain() {
super.paramFormatPlain();
return this;
}
// </FluentSetters>
}