public class HtmlSerializerSession extends XmlSerializerSession
HtmlSerializer
.
This class is NOT thread safe. It is typically discarded after one-time use although it can be reused within the same thread.
XmlSerializerSession.ContentResult
indent
Modifier | Constructor and Description |
---|---|
protected |
HtmlSerializerSession(HtmlSerializer ctx,
SerializerSessionArgs args)
Create a new session using properties specified in the context.
|
Modifier and Type | Method and Description |
---|---|
ObjectMap |
asMap()
Returns the properties defined on this bean context as a simple map for debugging purposes.
|
protected void |
doSerialize(SerializerPipe out,
Object o)
Serializes a POJO to the specified output stream or writer.
|
String |
getAnchorText(BeanPropertyMeta pMeta,
Object o)
Returns the anchor text to use for the specified URL object.
|
protected HtmlWriter |
getHtmlWriter(SerializerPipe out)
Converts the specified output target object to an
HtmlWriter . |
protected String |
getLabelParameter()
Configuration property: Link label parameter name.
|
protected AnchorText |
getUriAnchorText()
Configuration property: Anchor text source.
|
boolean |
isAddBeanTypeProperties()
Deprecated.
Unused.
|
protected boolean |
isAddBeanTypes()
Configuration property: Add
|
boolean |
isAddKeyValueTableHeaders()
Configuration property: Add key/value headers on bean/map tables.
|
protected boolean |
isDetectLinksInStrings()
Configuration property: Look for URLs in
Strings . |
boolean |
isHtmlMode()
Returns
|
protected boolean |
isLookForLabelParameters()
Configuration property: Look for link labels in URIs.
|
boolean |
isUri(ClassMeta<?> cm,
BeanPropertyMeta pMeta,
Object o)
Returns
|
protected XmlSerializerSession.ContentResult |
serializeAnything(XmlWriter out,
Object o,
ClassMeta<?> eType,
String name,
BeanPropertyMeta pMeta,
int xIndent,
boolean isRoot)
Serialize the specified object to the specified writer.
|
protected XmlSerializerSession.ContentResult |
serializeAnything(XmlWriter out,
Object o,
ClassMeta<?> eType,
String elementName,
Namespace elementNamespace,
boolean addNamespaceUris,
XmlFormat format,
boolean isMixed,
boolean preserveWhitespace,
BeanPropertyMeta pMeta)
Workhorse method.
|
findNsfMappings, getDefaultNamespace, getNamespaces, getXmlWriter, getXsNamespace, isAddNamespaceUrlsToRoot, isAutoDetectNamespaces, isEnableNamespaces
getMaxIndent, getQuoteChar, isWriterSerializer, serialize, serializeToString
canIgnoreValue, createBeanTypeNameProperty, createPipe, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, getUriResolver, isAddRootType, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNullProperties, isTrimStrings, isUseWhitespace, onBeanGetterException, onError, relativizeUri, resolveUri, serialize, sort, sort, toList, toString, trim
getInitialDepth, getLastLocation, getMaxDepth, getStack, isDetectRecursions, isIgnoreRecursions, pop, push, setCurrentClass, setCurrentProperty, willRecurse
_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getLocale, getMediaType, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newInstance, newInstance, newInstanceFromOuter, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap
addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString
protected HtmlSerializerSession(HtmlSerializer ctx, SerializerSessionArgs args)
ctx
- The context creating this session object.
The context contains all the configuration settings for this object.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 ObjectMap asMap()
Session
asMap
in class XmlSerializerSession
protected final HtmlWriter getHtmlWriter(SerializerPipe out) throws Exception
HtmlWriter
.out
- The output target object.HtmlWriter
.Exception
public boolean isUri(ClassMeta<?> cm, BeanPropertyMeta pMeta, Object o)
cm
- The ClassMeta of the object being serialized.pMeta
- The property metadata of the bean property of the object.
Can be o
- The object.public String getAnchorText(BeanPropertyMeta pMeta, Object o)
pMeta
- The property metadata of the bean property of the object.
Can be o
- The URL object.public boolean isHtmlMode()
XmlSerializerSession
The difference in behavior is how empty non-void elements are handled. The XML serializer will produce a collapsed tag, whereas the HTML serializer will produce a start and end tag.
isHtmlMode
in class XmlSerializerSession
protected void doSerialize(SerializerPipe out, Object o) throws Exception
SerializerSession
This method should NOT close the context object.
doSerialize
in class XmlSerializerSession
out
- Where to send the output from the serializer.o
- The object to serialize.Exception
- If thrown from underlying stream, or if the input contains a syntax error or is malformed.protected XmlSerializerSession.ContentResult serializeAnything(XmlWriter out, Object o, ClassMeta<?> eType, String elementName, Namespace elementNamespace, boolean addNamespaceUris, XmlFormat format, boolean isMixed, boolean preserveWhitespace, BeanPropertyMeta pMeta) throws Exception
XmlSerializerSession
serializeAnything
in class XmlSerializerSession
out
- The writer to send the output to.o
- The object to serialize.eType
- The expected type if this is a bean property value being serialized.elementName
- The root element name.elementNamespace
- The namespace of the element.addNamespaceUris
- Flag indicating that namespace URIs need to be added.format
- The format to serialize the output to.isMixed
- We're serializing mixed content, so don't use whitespace.preserveWhitespace
- XmlFormat.MIXED_PWS
or XmlFormat.TEXT_PWS
.pMeta
- The bean property metadata if this is a bean property being serialized.Exception
- If a problem occurred trying to convert the output.protected XmlSerializerSession.ContentResult serializeAnything(XmlWriter out, Object o, ClassMeta<?> eType, String name, BeanPropertyMeta pMeta, int xIndent, boolean isRoot) throws Exception
out
- The writer.o
- The object to serialize.eType
- The expected type of the object if this is a bean property.name
- The attribute name of this object if this object was a field in a JSON object (i.e. key of a
Map.Entry
or property name of a bean).pMeta
- The bean property being serialized, or xIndent
- The current indentation value.isRoot
- Exception
- If a problem occurred trying to convert the output.protected final boolean isLookForLabelParameters()
HtmlSerializer.HTML_detectLabelParameters
protected final boolean isDetectLinksInStrings()
Strings
.HtmlSerializer.HTML_detectLinksInStrings
public final boolean isAddKeyValueTableHeaders()
key
and value
column headers are added to tables.HtmlSerializer.HTML_addKeyValueTableHeaders
protected final boolean isAddBeanTypes()
isAddBeanTypes
in class XmlSerializerSession
HtmlSerializer.HTML_addBeanTypes
protected final String getLabelParameter()
HtmlSerializer.HTML_detectLabelParameters
.HtmlSerializer.HTML_labelParameter
protected final AnchorText getUriAnchorText()
<a href ='...'
> text</a>
) in HTML, this setting defines what to set the inner text to.HtmlSerializer.HTML_uriAnchorText
@Deprecated public final boolean isAddBeanTypeProperties()
Copyright © 2018 Apache. All rights reserved.