com.cedarsoftware.util.io

Class WriteOptionsBuilder

java.lang.Object

com.cedarsoftware.util.io.WriteOptionsBuilder

public class WriteOptionsBuilder
extends Object

Author:

Kenny Partlow ([email protected])
Copyright (c) Cedar Software LLC

Licensed 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.

Constructor Summary

Constructors

Constructor and Description
WriteOptionsBuilder()

Method Summary

Modifier and Type	Method and Description
static void	addBaseWriter(Class<?> c, JsonWriter.JsonClassWriter writer)
WriteOptionsBuilder	alwaysShowTypeInfo()
WriteOptions	build()
WriteOptionsBuilder	doNotForceMapOutputAsKeysAndItems()
WriteOptionsBuilder	doNotWritePrivateEnumFields()
WriteOptionsBuilder	forceMapOutputAsKeysAndItems()
static WriteOptionsBuilder	fromMap(Map args)
WriteOptionsBuilder	neverShowTypeInfo()
WriteOptionsBuilder	showMinimalTypeInfo()
WriteOptionsBuilder	skipNullFields()
static Map	toMap(WriteOptions options)
WriteOptionsBuilder	withClassLoader(ClassLoader classLoader)
WriteOptionsBuilder	withCustomArgument(String name, Object o)
WriteOptionsBuilder	withCustomArguments(Map<String,Object> map)
WriteOptionsBuilder	withCustomTypeName(Class<?> type, String newTypeName)
WriteOptionsBuilder	withCustomTypeName(String type, String newTypeName)
WriteOptionsBuilder	withCustomTypeNameMap(Map<String,String> map)
WriteOptionsBuilder	withCustomWriter(Class<?> c, JsonWriter.JsonClassWriter writer)
WriteOptionsBuilder	withCustomWriterMap(Map<? extends Class<?>,? extends JsonWriter.JsonClassWriter> map)
WriteOptionsBuilder	withDateFormat(String format)
WriteOptionsBuilder	withDefaultOptimizations()
WriteOptionsBuilder	withFieldNameBlackList(Class<?> c, Collection<String> fields)
WriteOptionsBuilder	withFieldNameBlackListMap(Map<Class<?>,Collection<String>> map)
WriteOptionsBuilder	withFieldSpecifier(Class<?> c, List<String> fields)
WriteOptionsBuilder	withFieldSpecifiersMap(Map<Class<?>,Collection<String>> map)
WriteOptionsBuilder	withIsoDateFormat()
WriteOptionsBuilder	withIsoDateTimeFormat()
WriteOptionsBuilder	withNoCustomizationFor(Class<?> c)
WriteOptionsBuilder	withNoCustomizationsFor(Collection<Class<?>> collection)
WriteOptionsBuilder	withPrettyPrint()
WriteOptionsBuilder	withPrintStyle(PrintStyle style)
WriteOptionsBuilder	withShortMetaKeys()
WriteOptionsBuilder	writeEnumsAsObject() This option only applies when you're writing enums as objects so we force the enum write to be ENUMS_AS_OBJECTS
WriteOptionsBuilder	writeEnumsAsPrimitives()
WriteOptionsBuilder	writeLocalDateAsTimeStamp()
WriteOptionsBuilder	writeLocalDateWithFormat(DateTimeFormatter formatter)
WriteOptionsBuilder	writeLongsAsStrings()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WriteOptionsBuilder

public WriteOptionsBuilder()

Method Detail

withDefaultOptimizations

public WriteOptionsBuilder withDefaultOptimizations()

skipNullFields

public WriteOptionsBuilder skipNullFields()

withPrettyPrint

public WriteOptionsBuilder withPrettyPrint()

withPrintStyle

public WriteOptionsBuilder withPrintStyle(PrintStyle style)

writeLongsAsStrings

public WriteOptionsBuilder writeLongsAsStrings()

writeEnumsAsObject

public WriteOptionsBuilder writeEnumsAsObject()

This option only applies when you're writing enums as objects so we force the enum write to be ENUMS_AS_OBJECTS

Returns:

doNotWritePrivateEnumFields

public WriteOptionsBuilder doNotWritePrivateEnumFields()

writeEnumsAsPrimitives

public WriteOptionsBuilder writeEnumsAsPrimitives()

forceMapOutputAsKeysAndItems

public WriteOptionsBuilder forceMapOutputAsKeysAndItems()

doNotForceMapOutputAsKeysAndItems

public WriteOptionsBuilder doNotForceMapOutputAsKeysAndItems()

withClassLoader

public WriteOptionsBuilder withClassLoader(ClassLoader classLoader)

addBaseWriter

public static void addBaseWriter(Class<?> c,
                                 JsonWriter.JsonClassWriter writer)

writeLocalDateAsTimeStamp

public WriteOptionsBuilder writeLocalDateAsTimeStamp()

writeLocalDateWithFormat

public WriteOptionsBuilder writeLocalDateWithFormat(DateTimeFormatter formatter)

withIsoDateTimeFormat

public WriteOptionsBuilder withIsoDateTimeFormat()

withIsoDateFormat

public WriteOptionsBuilder withIsoDateFormat()

withDateFormat

public WriteOptionsBuilder withDateFormat(String format)

withShortMetaKeys

public WriteOptionsBuilder withShortMetaKeys()

neverShowTypeInfo

public WriteOptionsBuilder neverShowTypeInfo()

alwaysShowTypeInfo

public WriteOptionsBuilder alwaysShowTypeInfo()

showMinimalTypeInfo

public WriteOptionsBuilder showMinimalTypeInfo()

withFieldNameBlackList

public WriteOptionsBuilder withFieldNameBlackList(Class<?> c,
                                                  Collection<String> fields)

withFieldNameBlackListMap

public WriteOptionsBuilder withFieldNameBlackListMap(Map<Class<?>,Collection<String>> map)

withFieldSpecifier

public WriteOptionsBuilder withFieldSpecifier(Class<?> c,
                                              List<String> fields)

withFieldSpecifiersMap

public WriteOptionsBuilder withFieldSpecifiersMap(Map<Class<?>,Collection<String>> map)

withCustomTypeName

public WriteOptionsBuilder withCustomTypeName(Class<?> type,
                                              String newTypeName)

withCustomTypeName

public WriteOptionsBuilder withCustomTypeName(String type,
                                              String newTypeName)

withCustomTypeNameMap

public WriteOptionsBuilder withCustomTypeNameMap(Map<String,String> map)

withCustomWriter

public WriteOptionsBuilder withCustomWriter(Class<?> c,
                                            JsonWriter.JsonClassWriter writer)

withCustomWriterMap

public WriteOptionsBuilder withCustomWriterMap(Map<? extends Class<?>,? extends JsonWriter.JsonClassWriter> map)

withNoCustomizationFor

public WriteOptionsBuilder withNoCustomizationFor(Class<?> c)

withNoCustomizationsFor

public WriteOptionsBuilder withNoCustomizationsFor(Collection<Class<?>> collection)

withCustomArgument

public WriteOptionsBuilder withCustomArgument(String name,
                                              Object o)

withCustomArguments

public WriteOptionsBuilder withCustomArguments(Map<String,Object> map)

toMap

public static Map toMap(WriteOptions options)

fromMap

public static WriteOptionsBuilder fromMap(Map args)

build

public WriteOptions build()