@ConfigurableContext public abstract class WriterSerializer extends Serializer
Serializer
for character-based serializers.Serializer.Null
Modifier and Type | Field and Description |
---|---|
static String |
WSERIALIZER_fileCharset
Configuration property: File charset.
|
static String |
WSERIALIZER_maxIndent
Configuration property: Maximum indentation.
|
static String |
WSERIALIZER_quoteChar
Configuration property: Quote character.
|
static String |
WSERIALIZER_streamCharset
Configuration property: Output stream charset.
|
static String |
WSERIALIZER_useWhitespace
Configuration property: Use whitespace.
|
SERIALIZER_addBeanTypes, SERIALIZER_addRootType, SERIALIZER_keepNullProperties, SERIALIZER_listener, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution
BEANTRAVERSE_detectRecursions, BEANTRAVERSE_ignoreRecursions, BEANTRAVERSE_initialDepth, BEANTRAVERSE_maxDepth
BEAN_annotations, BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreTransientFields, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_swaps, BEAN_swaps_add, BEAN_swaps_remove, BEAN_typePropertyName, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED
CONTEXT_debug, CONTEXT_locale, CONTEXT_mediaType, CONTEXT_timeZone
Modifier | Constructor and Description |
---|---|
protected |
WriterSerializer(PropertyStore ps,
String produces,
String accept)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
WriterSerializerSession |
createSession()
Create a new bean session based on the properties defined on this context.
|
abstract WriterSerializerSession |
createSession(SerializerSessionArgs args)
Create the session object used for actual serialization of objects.
|
protected Charset |
getFileCharset()
File charset.
|
protected int |
getMaxIndent()
Maximum indentation.
|
protected char |
getQuoteChar()
Quote character.
|
protected Charset |
getStreamCharset()
Output stream charset.
|
protected boolean |
isUseWhitespace()
Trim strings.
|
boolean |
isWriterSerializer()
Returns
WriterSerializer . |
WriterSerializer |
println(Object o)
Convenience method for serializing an object and sending it to STDOUT.
|
String |
serialize(Object o)
Convenience method for serializing an object to a
|
OMap |
toMap()
Returns the properties defined on this bean context as a simple map for debugging purposes.
|
String |
toString(Object o)
|
StringObject |
toStringObject(Object o)
Wraps the specified object inside a
StringObject . |
builder, createDefaultSessionArgs, getAcceptMediaTypes, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString
createSession, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions
_class, create, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, dumpCacheStats, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanToStringSerializer, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getDeclaredAnnotations, getDeclaredAnnotations, getExamples, getImplClassConstructor, getImplClasses, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastDeclaredAnnotation, getLastDeclaredAnnotation, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreTransientFields, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string
equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getDefaultLocale, getDefaultMediaType, getDefaultTimeZone, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, isDebug, toString
public static final String WSERIALIZER_fileCharset
WSERIALIZER_fileCharset
The character set to use for writing
Used when passing in files to Serializer.serialize(Object, Object)
.
public static final String WSERIALIZER_maxIndent
WSERIALIZER_maxIndent
Specifies the maximum indentation level in the serialized document.
public static final String WSERIALIZER_quoteChar
WSERIALIZER_quoteChar
Specifies the character to use for quoting attributes and values.
public static final String WSERIALIZER_streamCharset
WSERIALIZER_streamCharset
The character set to use when writing to
Used when passing in output streams and byte arrays to Serializer.serialize(Object, Object)
.
public static final String WSERIALIZER_useWhitespace
WSERIALIZER_useWhitespace
When enabled, whitespace is added to the output to improve readability.
protected WriterSerializer(PropertyStore ps, String produces, String accept)
ps
- The property store containing all the settings for this object.produces
- The media type that this serializer produces.accept
- The accept media types that the serializer can handle.
Can contain meta-characters per the
If empty, then assumes the only media type supported is
For example, if this serializer produces
The accept value can also contain q-values.
public abstract WriterSerializerSession createSession(SerializerSessionArgs args)
Serializer
createSession
in class Serializer
args
- Runtime arguments.
These specify session-level information such as locale and URI context.
It also include session-level properties that override the properties defined on the bean and serializer
contexts.public WriterSerializerSession createSession()
BeanContext
Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.
createSession
in class Serializer
public final boolean isWriterSerializer()
Serializer
WriterSerializer
.isWriterSerializer
in class Serializer
WriterSerializer
.public final String serialize(Object o) throws SerializeException
serialize
in class Serializer
o
- The object to serialize.SerializeException
- If a problem occurred trying to convert the output.public final String toString(Object o)
serialize(Object)
except throws a RuntimeException
instead of a SerializeException
.
This is typically good enough for debugging purposes.
o
- The object to serialize.public final StringObject toStringObject(Object o)
StringObject
.o
- The object to wrap.public final WriterSerializer println(Object o)
o
- The object to serialize.protected final Charset getFileCharset()
WSERIALIZER_fileCharset
protected final int getMaxIndent()
WSERIALIZER_maxIndent
protected char getQuoteChar()
WSERIALIZER_quoteChar
protected final Charset getStreamCharset()
WSERIALIZER_streamCharset
protected final boolean isUseWhitespace()
WSERIALIZER_useWhitespace
public OMap toMap()
Context
toMap
in class Serializer
Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.