org.apache.juneau.uon.UonSerializer Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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.uon;
import static org.apache.juneau.collections.JsonMap.*;
import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import java.util.concurrent.*;
import org.apache.juneau.*;
import org.apache.juneau.collections.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.serializer.*;
import org.apache.juneau.utils.*;
/**
* Serializes POJO models to UON (a notation for URL-encoded query parameter values).
*
* Media types
*
* Handles Accept types: text/uon
*
* Produces Content-Type types: text/uon
*
*
Description
*
* This serializer provides several serialization options.
* Typically, one of the predefined DEFAULT serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
*
*
* The following shows a sample object defined in Javascript:
*
* {
* id: 1,
* name: 'John Smith' ,
* uri: 'http://sample/addressBook/person/1' ,
* addressBookUri: 'http://sample/addressBook' ,
* birthDate: '1946-08-12T00:00:00Z' ,
* otherIds: null ,
* addresses: [
* {
* uri: 'http://sample/addressBook/address/1' ,
* personUri: 'http://sample/addressBook/person/1' ,
* id: 1,
* street: '100 Main Street' ,
* city: 'Anywhereville' ,
* state: 'NY' ,
* zip: 12345,
* isCurrent: true ,
* }
* ]
* }
*
*
*
* Using the "strict" syntax defined in this document, the equivalent UON notation would be as follows:
*
* (
* id =1 ,
* name ='John+Smith' ,
* uri =http://sample/addressBook/person/1 ,
* addressBookUri =http://sample/addressBook ,
* birthDate =1946-08-12T00:00:00Z ,
* otherIds =null ,
* addresses =@(
* (
* uri =http://sample/addressBook/address/1 ,
* personUri =http://sample/addressBook/person/1 ,
* id =1 ,
* street ='100+Main+Street' ,
* city =Anywhereville ,
* state =NY ,
* zip =12345 ,
* isCurrent =true
* )
* )
* )
*
*
* Example:
*
* // Serialize a Map
* Map map = JsonMap.ofJson ("{a:'b',c:1,d:false,e:['f',1,false],g:{h:'i'}}" );
*
* // Serialize to value equivalent to JSON.
* // Produces "(a=b,c=1,d=false,e=@(f,1,false),g=(h=i))"
* String uon = UonSerializer.DEFAULT .serialize(map );
*
* // Serialize a bean
* public class Person {
* public Person(String name );
* public String getName();
* public int getAge();
* public Address getAddress();
* public boolean deceased;
* }
*
* public class Address {
* public String getStreet();
* public String getCity();
* public String getState();
* public int getZip();
* }
*
* Person person = new Person("John Doe" , 23, "123 Main St" , "Anywhere" ,
* "NY" , 12345, false );
*
* // Produces "(name='John Doe',age=23,address=(street='123 Main St',city=Anywhere,state=NY,zip=12345),deceased=false)"
* String uon = UonSerializer.DEFAULT .serialize(person );
*
*
* Notes:
* - This class is thread safe and reusable.
*
*
* See Also:
* - UON Details
*
*/
public class UonSerializer extends WriterSerializer implements HttpPartSerializer, UonMetaProvider {
//-------------------------------------------------------------------------------------------------------------------
// Static
//-------------------------------------------------------------------------------------------------------------------
/** Reusable instance of {@link UonSerializer}, all default settings. */
public static final UonSerializer DEFAULT = new UonSerializer(create());
/** Reusable instance of {@link UonSerializer.Readable}. */
public static final UonSerializer DEFAULT_READABLE = new Readable(create());
/** Reusable instance of {@link UonSerializer.Encoding}. */
public static final UonSerializer DEFAULT_ENCODING = new Encoding(create());
/**
* Creates a new builder for this object.
*
* @return A new builder.
*/
public static Builder create() {
return new Builder();
}
//-------------------------------------------------------------------------------------------------------------------
// Static subclasses
//-------------------------------------------------------------------------------------------------------------------
/**
* Equivalent to UonSerializer.create ().ws().build();.
*/
public static class Readable extends UonSerializer {
/**
* Constructor.
*
* @param builder The builder for this object.
*/
public Readable(Builder builder) {
super(builder.useWhitespace());
}
}
/**
* Equivalent to UonSerializer.create ().encoding().build();.
*/
public static class Encoding extends UonSerializer {
/**
* Constructor.
*
* @param builder The builder for this object.
*/
public Encoding(Builder builder) {
super(builder.encoding());
}
}
/**
* Converts the specified value to a string that can be used as an HTTP header value, query parameter value,
* form-data parameter, or URI path variable.
*
*
* Returned values should NOT be URL-encoded.
*
* @param partType The category of value being serialized.
* @param schema
* Schema information about the part.
*
May be null .
*
Not all part serializers use the schema information.
* @param value The value being serialized.
* @return The serialized value.
* @throws SerializeException If a problem occurred while trying to parse the input.
* @throws SchemaValidationException If the output fails schema validation.
*/
public String serialize(HttpPartType partType, HttpPartSchema schema, Object value) throws SchemaValidationException, SerializeException {
return getPartSession().serialize(partType, schema, value);
}
//-------------------------------------------------------------------------------------------------------------------
// Builder
//-------------------------------------------------------------------------------------------------------------------
/**
* Builder class.
*/
@FluentSetters
public static class Builder extends WriterSerializer.Builder {
private static final Cache CACHE = Cache.of(HashKey.class, UonSerializer.class).build();
boolean addBeanTypesUon, encoding;
ParamFormat paramFormat;
Character quoteCharUon;
/**
* Constructor, default settings.
*/
protected Builder() {
produces("text/uon");
addBeanTypesUon = env("UonSerializer.addBeanTypesUon", false);
encoding = env("UonSerializer.encoding", false);
paramFormat = env("UonSerializer.paramFormat", ParamFormat.UON);
quoteCharUon = null;
}
/**
* Copy constructor.
*
* @param copyFrom The bean to copy from.
*/
protected Builder(UonSerializer copyFrom) {
super(copyFrom);
addBeanTypesUon = copyFrom.addBeanTypesUon;
encoding = copyFrom.encoding;
paramFormat = copyFrom.paramFormat;
quoteCharUon = copyFrom.quoteCharUon;
}
/**
* Copy constructor.
*
* @param copyFrom The builder to copy from.
*/
protected Builder(Builder copyFrom) {
super(copyFrom);
addBeanTypesUon = copyFrom.addBeanTypesUon;
encoding = copyFrom.encoding;
paramFormat = copyFrom.paramFormat;
quoteCharUon = copyFrom.quoteCharUon;
}
@Override /* Context.Builder */
public Builder copy() {
return new Builder(this);
}
@Override /* Context.Builder */
public UonSerializer build() {
return cache(CACHE).build(UonSerializer.class);
}
@Override /* Context.Builder */
public HashKey hashKey() {
return HashKey.of(
super.hashKey(),
addBeanTypesUon,
encoding,
paramFormat,
quoteCharUon
);
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Add "_type" properties when needed.
*
*
* If true , then "_type" properties will be added to beans if their type cannot be inferred
* through reflection.
*
*
* When present, this value overrides the {@link org.apache.juneau.serializer.Serializer.Builder#addBeanTypes()} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerSet}.
*
* @return This object.
*/
@FluentSetter
public Builder addBeanTypesUon() {
return addBeanTypesUon(true);
}
/**
* Same as {@link #addBeanTypesUon()} but allows you to explicitly specify the value.
*
* @param value The value for this setting.
* @return This object.
*/
@FluentSetter
public Builder addBeanTypesUon(boolean value) {
addBeanTypesUon = value;
return this;
}
/**
* Encode non-valid URI characters.
*
*
* Encode non-valid URI characters with "%xx" constructs.
*
*
* If true , non-valid URI characters will be converted to "%xx" sequences.
*
Set to false if parameter value is being passed to some other code that will already perform
* URL-encoding of non-valid URI characters.
*
*
Example:
*
* // Create a non-encoding UON serializer.
* UonSerializer serializer1 = UonSerializer.
* .create ()
* .build();
*
* // Create an encoding UON serializer.
* UonSerializer serializer2 = UonSerializer.
* .create ()
* .encoding()
* .build();
*
* JsonMap map = JsonMap.of ("foo" , "foo bar" );
*
* // Produces: "(foo=foo bar)"
* String uon1 = serializer1 .serialize(map )
*
* // Produces: "(foo=foo%20bar)"
* String uon2 = serializer2 .serialize(map )
*
*
* @return This object.
*/
@FluentSetter
public Builder encoding() {
return encoding(true);
}
/**
* Same as {@link #encoding()} but allows you to disable the previous setting.
*
* @param value The new value for this setting.
* @return This object.
*/
public Builder encoding(boolean value) {
encoding = value;
return this;
}
/**
* Format to use for query/form-data/header values.
*
*
* Specifies the format to use for URL GET parameter keys and values.
*
*
Example:
*
* // Create a normal UON serializer.
* UonSerializer serializer1 = UonSerializer
* .create ()
* .build();
*
* // Create a plain-text UON serializer.
* UonSerializer serializer2 = UonSerializer
* .create ()
* .paramFormat(PLAIN_TEXT )
* .build();
*
* JsonMap map = JsonMap.of (
* "foo" , "bar" ,
* "baz" , new String[]{"qux" , "true" , "123" }
* );
*
* // Produces: "(foo=bar,baz=@(qux,'true','123'))"
* String uon1 = serializer1 .serialize(map )
*
* // Produces: "foo=bar,baz=qux,true,123"
* String uon2 = serializer2 .serialize(map )
*
*
*
*
* - {@link ParamFormat#UON} (default) - Use UON notation for parameters.
*
- {@link ParamFormat#PLAINTEXT} - Use plain text for parameters.
*
*
* @param value
* The new value for this property.
*
The default value is {@link ParamFormat#UON}.
* @return This object.
*/
@FluentSetter
public Builder paramFormat(ParamFormat value) {
paramFormat = value;
return this;
}
/**
* Format to use for query/form-data/header values.
*
*
* Specifies plain-text for the format to use for URL GET parameter keys and values.
*
*
Example:
*
* // Create a plain-text UON serializer.
* UonSerializer serializer = UonSerializer
* .create ()
* .paramFormatPlain()
* .build();
*
* JsonMap map = JsonMap.of (
* "foo" , "bar" ,
* "baz" , new String[]{"qux" , "true" , "123" }
* );
*
* // Produces: "foo=bar,baz=qux,true,123"
* String uon = serializer .serialize(map )
*
*
* @return This object.
*/
@FluentSetter
public Builder paramFormatPlain() {
return paramFormat(ParamFormat.PLAINTEXT);
}
/**
* Specifies the quote character.
*
* @param value The value for this setting.
* @return This object.
*/
@FluentSetter
public Builder quoteCharUon(char value) {
quoteCharUon = value;
return this;
}
//
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder annotations(Annotation...values) {
super.annotations(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder apply(AnnotationWorkList work) {
super.apply(work);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder applyAnnotations(java.lang.Class...fromClasses) {
super.applyAnnotations(fromClasses);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder applyAnnotations(Method...fromMethods) {
super.applyAnnotations(fromMethods);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder cache(Cache value) {
super.cache(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder debug() {
super.debug();
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder debug(boolean value) {
super.debug(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder impl(Context value) {
super.impl(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder type(Class value) {
super.type(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanClassVisibility(Visibility value) {
super.beanClassVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanConstructorVisibility(Visibility value) {
super.beanConstructorVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanContext(BeanContext value) {
super.beanContext(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanContext(BeanContext.Builder value) {
super.beanContext(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanDictionary(java.lang.Class...values) {
super.beanDictionary(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanFieldVisibility(Visibility value) {
super.beanFieldVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanInterceptor(Class on, Class> value) {
super.beanInterceptor(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanMapPutReturnsOldValue() {
super.beanMapPutReturnsOldValue();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanMethodVisibility(Visibility value) {
super.beanMethodVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanProperties(Map values) {
super.beanProperties(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanProperties(Class beanClass, String properties) {
super.beanProperties(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanProperties(String beanClassName, String properties) {
super.beanProperties(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesExcludes(Map values) {
super.beanPropertiesExcludes(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesExcludes(Class beanClass, String properties) {
super.beanPropertiesExcludes(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesExcludes(String beanClassName, String properties) {
super.beanPropertiesExcludes(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesReadOnly(Map values) {
super.beanPropertiesReadOnly(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesReadOnly(Class beanClass, String properties) {
super.beanPropertiesReadOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesReadOnly(String beanClassName, String properties) {
super.beanPropertiesReadOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesWriteOnly(Map values) {
super.beanPropertiesWriteOnly(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesWriteOnly(Class beanClass, String properties) {
super.beanPropertiesWriteOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesWriteOnly(String beanClassName, String properties) {
super.beanPropertiesWriteOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beansRequireDefaultConstructor() {
super.beansRequireDefaultConstructor();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beansRequireSerializable() {
super.beansRequireSerializable();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beansRequireSettersForGetters() {
super.beansRequireSettersForGetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder dictionaryOn(Class on, java.lang.Class...values) {
super.dictionaryOn(on, values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableBeansRequireSomeProperties() {
super.disableBeansRequireSomeProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableIgnoreMissingSetters() {
super.disableIgnoreMissingSetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableIgnoreTransientFields() {
super.disableIgnoreTransientFields();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableIgnoreUnknownNullBeanProperties() {
super.disableIgnoreUnknownNullBeanProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableInterfaceProxies() {
super.disableInterfaceProxies();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder example(Class pojoClass, T o) {
super.example(pojoClass, o);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder example(Class pojoClass, String json) {
super.example(pojoClass, json);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder findFluentSetters() {
super.findFluentSetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder findFluentSetters(Class on) {
super.findFluentSetters(on);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreInvocationExceptionsOnGetters() {
super.ignoreInvocationExceptionsOnGetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreInvocationExceptionsOnSetters() {
super.ignoreInvocationExceptionsOnSetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreUnknownBeanProperties() {
super.ignoreUnknownBeanProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreUnknownEnumValues() {
super.ignoreUnknownEnumValues();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder implClass(Class interfaceClass, Class implClass) {
super.implClass(interfaceClass, implClass);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder implClasses(Map,Class> values) {
super.implClasses(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder interfaceClass(Class on, Class value) {
super.interfaceClass(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder interfaces(java.lang.Class...value) {
super.interfaces(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder locale(Locale value) {
super.locale(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder mediaType(MediaType value) {
super.mediaType(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder notBeanClasses(java.lang.Class...values) {
super.notBeanClasses(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder notBeanPackages(String...values) {
super.notBeanPackages(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder propertyNamer(Class value) {
super.propertyNamer(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder propertyNamer(Class on, Class value) {
super.propertyNamer(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder sortProperties() {
super.sortProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder sortProperties(java.lang.Class...on) {
super.sortProperties(on);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder stopClass(Class on, Class value) {
super.stopClass(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder swap(Class normalClass, Class swappedClass, ThrowingFunction swapFunction) {
super.swap(normalClass, swappedClass, swapFunction);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder swap(Class normalClass, Class swappedClass, ThrowingFunction swapFunction, ThrowingFunction unswapFunction) {
super.swap(normalClass, swappedClass, swapFunction, unswapFunction);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder swaps(java.lang.Class...values) {
super.swaps(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder timeZone(TimeZone value) {
super.timeZone(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder typeName(Class on, String value) {
super.typeName(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder typePropertyName(String value) {
super.typePropertyName(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder typePropertyName(Class on, String value) {
super.typePropertyName(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder useEnumNames() {
super.useEnumNames();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder useJavaBeanIntrospector() {
super.useJavaBeanIntrospector();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder detectRecursions() {
super.detectRecursions();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder detectRecursions(boolean value) {
super.detectRecursions(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder ignoreRecursions() {
super.ignoreRecursions();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder ignoreRecursions(boolean value) {
super.ignoreRecursions(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder initialDepth(int value) {
super.initialDepth(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder maxDepth(int value) {
super.maxDepth(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder accept(String value) {
super.accept(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addBeanTypes() {
super.addBeanTypes();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addBeanTypes(boolean value) {
super.addBeanTypes(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addRootType() {
super.addRootType();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addRootType(boolean value) {
super.addRootType(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder keepNullProperties() {
super.keepNullProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder keepNullProperties(boolean value) {
super.keepNullProperties(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder listener(Class value) {
super.listener(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder produces(String value) {
super.produces(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortCollections() {
super.sortCollections();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortCollections(boolean value) {
super.sortCollections(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortMaps() {
super.sortMaps();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortMaps(boolean value) {
super.sortMaps(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyCollections() {
super.trimEmptyCollections();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyCollections(boolean value) {
super.trimEmptyCollections(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyMaps() {
super.trimEmptyMaps();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyMaps(boolean value) {
super.trimEmptyMaps(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimStrings() {
super.trimStrings();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimStrings(boolean value) {
super.trimStrings(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder uriContext(UriContext value) {
super.uriContext(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder uriRelativity(UriRelativity value) {
super.uriRelativity(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder uriResolution(UriResolution value) {
super.uriResolution(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder fileCharset(Charset value) {
super.fileCharset(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder maxIndent(int value) {
super.maxIndent(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder quoteChar(char value) {
super.quoteChar(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder quoteCharOverride(char value) {
super.quoteCharOverride(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder sq() {
super.sq();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder streamCharset(Charset value) {
super.streamCharset(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder useWhitespace() {
super.useWhitespace();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder useWhitespace(boolean value) {
super.useWhitespace(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder ws() {
super.ws();
return this;
}
//
}
//-------------------------------------------------------------------------------------------------------------------
// Instance
//-------------------------------------------------------------------------------------------------------------------
final boolean
encoding,
addBeanTypesUon;
final ParamFormat
paramFormat;
final Character
quoteCharUon;
private final boolean addBeanTypes;
private final char quoteChar;
private final Map,UonClassMeta> uonClassMetas = new ConcurrentHashMap<>();
private final Map uonBeanPropertyMetas = new ConcurrentHashMap<>();
/**
* Constructor.
*
* @param builder
* The builder for this object.
*/
public UonSerializer(Builder builder) {
super(builder);
encoding = builder.encoding;
addBeanTypesUon = builder.addBeanTypesUon;
paramFormat = builder.paramFormat;
quoteCharUon = builder.quoteCharUon;
addBeanTypes = addBeanTypesUon || super.isAddBeanTypes();
quoteChar = quoteCharUon != null ? quoteCharUon : super.quoteChar() != null ? super.quoteChar() : '\'';
}
@Override /* Context */
public Builder copy() {
return new Builder(this);
}
@Override /* Context */
public UonSerializerSession.Builder createSession() {
return UonSerializerSession.create(this);
}
@Override /* Context */
public UonSerializerSession getSession() {
return createSession().build();
}
@Override /* HttpPartSerializer */
public UonSerializerSession getPartSession() {
return UonSerializerSession.create(this).build();
}
//-----------------------------------------------------------------------------------------------------------------
// Extended metadata
//-----------------------------------------------------------------------------------------------------------------
@Override /* UonMetaProvider */
public UonClassMeta getUonClassMeta(ClassMeta cm) {
UonClassMeta m = uonClassMetas.get(cm);
if (m == null) {
m = new UonClassMeta(cm, this);
uonClassMetas.put(cm, m);
}
return m;
}
@Override /* UonMetaProvider */
public UonBeanPropertyMeta getUonBeanPropertyMeta(BeanPropertyMeta bpm) {
if (bpm == null)
return UonBeanPropertyMeta.DEFAULT;
UonBeanPropertyMeta m = uonBeanPropertyMetas.get(bpm);
if (m == null) {
m = new UonBeanPropertyMeta(bpm.getDelegateFor(), this);
uonBeanPropertyMetas.put(bpm, m);
}
return m;
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Add "_type" properties when needed.
*
* @see Builder#addBeanTypesUon()
* @return
* true if "_type" properties will be added to beans if their type cannot be inferred
* through reflection.
*/
@Override
protected final boolean isAddBeanTypes() {
return addBeanTypes;
}
/**
* Encode non-valid URI characters.
*
* @see Builder#encoding()
* @return
* true if non-valid URI characters should be encoded with "%xx" constructs.
*/
protected final boolean isEncoding() {
return encoding;
}
/**
* Format to use for query/form-data/header values.
*
* @see Builder#paramFormat(ParamFormat)
* @return
* Specifies the format to use for URL GET parameter keys and values.
*/
protected final ParamFormat getParamFormat() {
return paramFormat;
}
/**
* Quote character.
*
* @see Builder#quoteCharUon(char)
* @return
* The character used for quoting attributes and values.
*/
@Override
protected final char getQuoteChar() {
return quoteChar;
}
//-----------------------------------------------------------------------------------------------------------------
// Other methods
//-----------------------------------------------------------------------------------------------------------------
@Override /* Context */
protected JsonMap properties() {
return filteredMap("encoding", encoding, "addBeanTypes", addBeanTypes, "paramFormat", paramFormat);
}
}