org.apache.juneau.serializer.WriterSerializer 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.serializer;
import static org.apache.juneau.collections.JsonMap.*;
import static org.apache.juneau.common.internal.ThrowableUtils.*;
import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.collections.*;
import org.apache.juneau.common.internal.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.json.*;
import org.apache.juneau.utils.*;
/**
* Subclass of {@link Serializer} for character-based serializers.
*
* Notes:
* - This class is thread safe and reusable.
*
*
* See Also:
*/
public class WriterSerializer extends Serializer {
//-------------------------------------------------------------------------------------------------------------------
// Static
//-------------------------------------------------------------------------------------------------------------------
/**
* Creates a new builder for this object.
*
* @return A new builder.
*/
public static Builder create() {
return new Builder();
}
//-------------------------------------------------------------------------------------------------------------------
// Builder
//-------------------------------------------------------------------------------------------------------------------
/**
* Builder class.
*/
@FluentSetters
public static class Builder extends Serializer.Builder {
boolean useWhitespace;
Charset fileCharset, streamCharset;
int maxIndent;
Character quoteChar, quoteCharOverride;
/**
* Constructor, default settings.
*/
protected Builder() {
fileCharset = Charset.defaultCharset();
streamCharset = IOUtils.UTF8;
maxIndent = env("WriterSerializer.maxIndent", 100);
quoteChar = env("WriterSerializer.quoteChar", (Character)null);
quoteCharOverride = env("WriterSerializer.quoteCharOverride", (Character)null);
useWhitespace = env("WriterSerializer.useWhitespace", false);
}
/**
* Copy constructor.
*
* @param copyFrom The bean to copy from.
*/
protected Builder(WriterSerializer copyFrom) {
super(copyFrom);
fileCharset = copyFrom.fileCharset;
streamCharset = copyFrom.streamCharset;
maxIndent = copyFrom.maxIndent;
quoteChar = copyFrom.quoteChar;
quoteCharOverride = copyFrom.quoteCharOverride;
useWhitespace = copyFrom.useWhitespace;
}
/**
* Copy constructor.
*
* @param copyFrom The builder to copy from.
*/
protected Builder(Builder copyFrom) {
super(copyFrom);
fileCharset = copyFrom.fileCharset;
streamCharset = copyFrom.streamCharset;
maxIndent = copyFrom.maxIndent;
quoteChar = copyFrom.quoteChar;
quoteCharOverride = copyFrom.quoteCharOverride;
useWhitespace = copyFrom.useWhitespace;
}
@Override /* Context.Builder */
public Builder copy() {
return new Builder(this);
}
@Override /* Context.Builder */
public WriterSerializer build() {
return build(WriterSerializer.class);
}
@Override /* Context.Builder */
public HashKey hashKey() {
return HashKey.of(
super.hashKey(),
fileCharset,
streamCharset,
maxIndent,
quoteChar,
quoteCharOverride,
useWhitespace
);
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* File charset.
*
*
* The character set to use for writing Files to the file system.
*
*
* Used when passing in files to {@link Serializer#serialize(Object, Object)}.
*
*
Example:
*
* // Create a serializer that writes UTF-8 files.
* WriterSerializer serializer = JsonSerializer
* .create ()
* .fileCharset(Charset.forName ("UTF-8" ))
* .build();
*
* // Use it to read a UTF-8 encoded file.
* serializer .serialize(new File("MyBean.txt" ), myBean );
*
*
* @param value
* The new value for this property.
*
The default is the system JVM setting.
* @return This object.
*/
@FluentSetter
public Builder fileCharset(Charset value) {
fileCharset = value;
return this;
}
/**
* Maximum indentation.
*
*
* Specifies the maximum indentation level in the serialized document.
*
*
Notes:
* - This setting does not apply to the RDF serializers.
*
*
* Example:
*
* // Create a serializer that indents a maximum of 20 tabs.
* WriterSerializer serializer = JsonSerializer
* .create ()
* .ws() // Enable whitespace
* .maxIndent(20)
* .build();
*
*
* @param value
* The new value for this property.
*
The default is 100 .
* @return This object.
*/
@FluentSetter
public Builder maxIndent(int value) {
maxIndent = value;
return this;
}
/**
* Quote character.
*
*
* Specifies the character to use for quoting attributes and values.
*
*
Notes:
* - This setting does not apply to the RDF serializers.
*
*
* Example:
*
* // Create a serializer that uses single quotes.
* WriterSerializer serializer = JsonSerializer
* .create ()
* .quoteChar('\'' )
* .build();
*
* // A bean with a single property
* public class MyBean {
* public String foo = "bar" ;
* }
*
* // Produces {'foo':'bar'}
* String json = serializer .toString(new MyBean());
*
*
* @param value
* The new value for this property.
*
The default is '"' .
* @return This object.
*/
@FluentSetter
public Builder quoteChar(char value) {
quoteChar = value;
return this;
}
/**
* Quote character override.
*
*
* Similar to {@link #quoteChar(char)} but takes precedence over that setting.
*
*
* Allows you to override the quote character even if it's set by a subclass such as {@link Json5Serializer}.
*
*
* @param value
* The new value for this property.
*
The default is null .
* @return This object.
*/
@FluentSetter
public Builder quoteCharOverride(char value) {
quoteCharOverride = value;
return this;
}
/**
* Quote character.
*
*
* Specifies to use single quotes for quoting attributes and values.
*
*
Notes:
* - This setting does not apply to the RDF serializers.
*
*
* Example:
*
* // Create a serializer that uses single quotes.
* WriterSerializer serializer = JsonSerializer
* .create ()
* .sq()
* .build();
*
* // A bean with a single property
* public class MyBean {
* public String foo = "bar" ;
* }
*
* // Produces {'foo':'bar'}
* String json = serializer .toString(new MyBean());
*
*
* @return This object.
*/
@FluentSetter
public Builder sq() {
return quoteChar('\'');
}
/**
* Output stream charset.
*
*
* The character set to use when writing to OutputStreams .
*
*
* Used when passing in output streams and byte arrays to {@link WriterSerializer#serialize(Object, Object)}.
*
*
Example:
*
* // Create a serializer that writes UTF-8 files.
* WriterSerializer serializer = JsonSerializer
* .create ()
* .streamCharset(Charset.forName ("UTF-8" ))
* .build();
*
* // Use it to write to a UTF-8 encoded output stream.
* serializer .serializer(new FileOutputStreamStream("MyBean.txt" ), myBean );
*
*
* @param value
* The new value for this property.
*
The default is the system JVM setting.
* @return This object.
*/
@FluentSetter
public Builder streamCharset(Charset value) {
streamCharset = value;
return this;
}
/**
* Use whitespace.
*
*
* When enabled, whitespace is added to the output to improve readability.
*
*
Example:
*
* // Create a serializer with whitespace enabled.
* WriterSerializer serializer = JsonSerializer
* .create ()
* .useWhitespace()
* .build();
*
* // A bean with a single property
* public class MyBean {
* public String foo = "bar" ;
* }
*
* // Produces "\{\n\t"foo": "bar"\n\}\n"
* String json = serializer .serialize(new MyBean());
*
*
* @return This object.
*/
@FluentSetter
public Builder useWhitespace() {
return useWhitespace(true);
}
/**
* Same as {@link #useWhitespace()} but allows you to explicitly specify the value.
*
* @param value The value for this setting.
* @return This object.
*/
@FluentSetter
public Builder useWhitespace(boolean value) {
useWhitespace = value;
return this;
}
/**
* Use whitespace.
*
*
* When enabled, whitespace is added to the output to improve readability.
*
*
Example:
*
* // Create a serializer with whitespace enabled.
* WriterSerializer serializer = JsonSerializer
* .create ()
* .ws()
* .build();
*
* // A bean with a single property
* public class MyBean {
* public String foo = "bar" ;
* }
*
* // Produces "\{\n\t"foo": "bar"\n\}\n"
* String json = serializer .serialize(new MyBean());
*
*
* @return This object.
*/
@FluentSetter
public Serializer.Builder ws() {
return useWhitespace();
}
//
@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;
}
//
}
//-------------------------------------------------------------------------------------------------------------------
// Instance
//-------------------------------------------------------------------------------------------------------------------
final Charset fileCharset, streamCharset;
final int maxIndent;
final Character quoteChar, quoteCharOverride;
final boolean useWhitespace;
private final char quoteCharValue;
/**
* Constructor.
*
* @param builder
* The builder for this object.
*/
protected WriterSerializer(Builder builder) {
super(builder);
maxIndent = builder.maxIndent;
quoteChar = builder.quoteChar;
quoteCharOverride = builder.quoteCharOverride;
streamCharset = builder.streamCharset;
fileCharset = builder.fileCharset;
useWhitespace = builder.useWhitespace;
quoteCharValue = quoteCharOverride != null ? quoteCharOverride : quoteChar != null ? quoteChar : '"';
}
@Override /* Context */
public Builder copy() {
return new Builder(this);
}
@Override /* Context */
public WriterSerializerSession.Builder createSession() {
return WriterSerializerSession.create(this);
}
@Override /* Context */
public WriterSerializerSession getSession() {
return createSession().build();
}
@Override /* Serializer */
public final boolean isWriterSerializer() {
return true;
}
/**
* Convenience method for serializing an object to a String .
*
* @param o The object to serialize.
* @return The output serialized to a string.
* @throws SerializeException If a problem occurred trying to convert the output.
*/
@Override /* Serializer */
public final String serialize(Object o) throws SerializeException {
return getSession().serialize(o);
}
/**
* Identical to {@link #serialize(Object)} except throws a {@link RuntimeException} instead of a {@link SerializeException}.
*
*
* This is typically good enough for debugging purposes.
*
* @param o The object to serialize.
* @return The serialized object.
*/
public final String toString(Object o) {
try {
return serialize(o);
} catch (Exception e) {
throw asRuntimeException(e);
}
}
/**
* Convenience method for serializing an object and sending it to STDOUT.
*
* @param o The object to serialize.
* @return This object.
*/
public final WriterSerializer println(Object o) {
System.out.println(toString(o)); // NOT DEBUG
return this;
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* File charset.
*
* @see Builder#fileCharset(Charset)
* @return
* The character set to use when writing to Files on the file system.
*/
protected final Charset getFileCharset() {
return fileCharset;
}
/**
* Maximum indentation.
*
* @see Builder#maxIndent(int)
* @return
* The maximum indentation level in the serialized document.
*/
protected final int getMaxIndent() {
return maxIndent;
}
/**
* Quote character.
*
* @see Builder#quoteChar(char)
* @return
* The character used for quoting attributes and values.
*/
protected char getQuoteChar() {
return quoteCharValue;
}
/**
* Quote character.
*
* @see Builder#quoteChar(char)
* @return
* The character used for quoting attributes and values.
*/
protected Character quoteChar() {
return quoteCharOverride != null ? quoteCharOverride : quoteChar;
}
/**
* Output stream charset.
*
* @see Builder#streamCharset(Charset)
* @return
* The character set to use when writing to OutputStreams and byte arrays.
*/
protected final Charset getStreamCharset() {
return streamCharset;
}
/**
* Trim strings.
*
* @see Builder#useWhitespace()
* @return
* When enabled, whitespace is added to the output to improve readability.
*/
protected final boolean isUseWhitespace() {
return useWhitespace;
}
//-----------------------------------------------------------------------------------------------------------------
// Other methods
//-----------------------------------------------------------------------------------------------------------------
@Override /* Context */
protected JsonMap properties() {
return filteredMap("fileCharset", fileCharset, "maxIndent", maxIndent, "quoteChar", quoteChar, "streamCharset", streamCharset, "useWhitespace", useWhitespace);
}
}