@ConfigurableContext public class UrlEncodingSerializer extends UonSerializer
Produces
The following shows a sample object defined in Javascript:
{
id: 1,
name:
Using the "strict" syntax defined in this document, the equivalent URL-encoded notation would be as follows:
Modifier and Type | Class and Description |
---|---|
static class |
UrlEncodingSerializer.Expanded
Equivalent to
UrlEncodingSerializer. . |
static class |
UrlEncodingSerializer.PlainText
Equivalent to
UrlEncodingSerializer. . |
static class |
UrlEncodingSerializer.Readable
Equivalent to
UrlEncodingSerializer. . |
UonSerializer.Encoding
HttpPartSerializer.Null
Modifier and Type | Field and Description |
---|---|
static UrlEncodingSerializer |
DEFAULT
Reusable instance of
UrlEncodingSerializer , all default settings. |
static UrlEncodingSerializer |
DEFAULT_EXPANDED
Reusable instance of
UrlEncodingSerializer.Expanded . |
static UrlEncodingSerializer |
DEFAULT_PLAINTEXT
Reusable instance of
UrlEncodingSerializer.PlainText . |
static UrlEncodingSerializer |
DEFAULT_READABLE
Reusable instance of
UrlEncodingSerializer.Readable . |
static String |
URLENC_expandedParams
Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
|
DEFAULT_ENCODING, UON_addBeanTypes, UON_encoding, UON_paramFormat
WSERIALIZER_fileCharset, WSERIALIZER_maxIndent, WSERIALIZER_quoteChar, WSERIALIZER_streamCharset, WSERIALIZER_useWhitespace
SERIALIZER_addBeanTypes, SERIALIZER_addRootType, 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_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_beanTypePropertyName, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, 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_timeZone, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED
Constructor and Description |
---|
UrlEncodingSerializer(PropertyStore ps)
Constructor.
|
UrlEncodingSerializer(PropertyStore ps,
String produces,
String accept)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
UrlEncodingSerializerBuilder |
builder()
Creates a builder from this context object.
|
static UrlEncodingSerializerBuilder |
create()
Instantiates a new clean-slate
UrlEncodingSerializerBuilder object. |
UrlEncodingSerializerSession |
createSession()
Create a new bean session based on the properties defined on this context.
|
UrlEncodingSerializerSession |
createSession(SerializerSessionArgs args)
Create the session object used for actual serialization of objects.
|
protected boolean |
isExpandedParams()
Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
|
ObjectMap |
toMap()
Returns the properties defined on this bean context as a simple map for debugging purposes.
|
createPartSession, createPartSession, getParamFormat, isAddBeanTypes, isEncoding, serialize, serialize
getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, serialize, toString, toStringObject
createDefaultSessionArgs, getAcceptMediaTypes, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNullProperties, isTrimStrings, serialize, serializeToString
createSession, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions
_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getExcludeProperties, getExcludeProperties, getImplClassConstructor, getImplClasses, getIncludeProperties, getIncludeProperties, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, 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, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, toString
public static final String URLENC_expandedParams
If
If
This option only applies to beans.
public static final UrlEncodingSerializer DEFAULT
UrlEncodingSerializer
, all default settings.public static final UrlEncodingSerializer DEFAULT_PLAINTEXT
UrlEncodingSerializer.PlainText
.public static final UrlEncodingSerializer DEFAULT_EXPANDED
UrlEncodingSerializer.Expanded
.public static final UrlEncodingSerializer DEFAULT_READABLE
UrlEncodingSerializer.Readable
.public UrlEncodingSerializer(PropertyStore ps)
ps
- The property store containing all the settings for this object.public UrlEncodingSerializer(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 UrlEncodingSerializerBuilder builder()
Context
Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.
builder
in class UonSerializer
public static UrlEncodingSerializerBuilder create()
UrlEncodingSerializerBuilder
object.
This is equivalent to simply calling
.
Note that this method creates a builder initialized to all default settings, whereas builder()
copies
the settings of the object called on.
UrlEncodingSerializerBuilder
object.public UrlEncodingSerializerSession 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 UonSerializer
public UrlEncodingSerializerSession createSession(SerializerSessionArgs args)
Serializer
createSession
in class UonSerializer
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.protected final boolean isExpandedParams()
URLENC_expandedParams
public ObjectMap toMap()
Context
toMap
in class UonSerializer
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.