com.bstek.dorado.view.output

Class ObjectOutputter

java.lang.Object

com.bstek.dorado.view.output.ObjectOutputter

All Implemented Interfaces:

Outputter

Direct Known Subclasses:

ClientObjectOutputter

public class ObjectOutputter
extends java.lang.Object
implements Outputter

Since:

2009-12-24

Author:

Benny Bao (mailto:benny.bao@bstek.com)

Constructor Summary

Constructors

Constructor and Description
ObjectOutputter()

Method Summary

Methods

Modifier and Type	Method and Description
EscapeMode	getEscapeMode()
java.util.Map<java.lang.String,PropertyConfig>	getPropertieConfigs() 返回要输出的POJO属性的Map集合。
protected boolean	isEscapeable(OutputContext context)
void	output(java.lang.Object object, OutputContext context) 输出组件。
protected void	outputObject(java.lang.Object object, OutputContext context) 将一个Java的POJO对象输出成为JSON对象。
protected void	outputObjectProperties(java.lang.Object object, OutputContext context) 输出一个Java的POJO对象中在#getConfigProperties()配置过的各个POJO属性。
void	setEscapeMode(EscapeMode escapeMode)
void	setPropertieConfigs(java.util.Map<java.lang.String,PropertyConfig> propertieConfigs) 设置要输出的POJO属性的Map集合。 其中Map集合的键为属性名，不同类型的键值具有不同的含义： 通常情况下键值会被默认为是相应属性的默认值。 即当某个要输出的POJO属性值与默认值相同时，该属性将被忽略而不会输出到JSON中。 当键值是PropertyOutputter的实现类时，键值代表一个子属性的输出器。 此时系统会将该属性的输出任务分派给这个子输出器。 当键值是VirtualPropertyOutputter的实现类时，键值代表一个虚拟属性的输出器。 虚拟属性是指并不一定真的存在于要输出的Java对象中的属性，只是我们希望在进行输出时输出这样一个属性值。 字符串"#default"是一个特殊的默认值，并且对于不同数据类型的属性而言"#default"又代表不同含义： 对String而言"#default"表示null或""。 对boolean而言"#default"表示false。 对int、long、float、double等而言"#default"表示0。 对其他数据类型而言"#default"表示null。 字符串"#ignore"是一个特殊的值，表示忽略该属性的输出操作。

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectOutputter

public ObjectOutputter()

Method Detail

getEscapeMode

public EscapeMode getEscapeMode()

setEscapeMode

public void setEscapeMode(EscapeMode escapeMode)

getPropertieConfigs

public java.util.Map<java.lang.String,PropertyConfig> getPropertieConfigs()

返回要输出的POJO属性的Map集合。

setPropertieConfigs

public void setPropertieConfigs(java.util.Map<java.lang.String,PropertyConfig> propertieConfigs)

设置要输出的POJO属性的Map集合。
其中Map集合的键为属性名，不同类型的键值具有不同的含义：

• 通常情况下键值会被默认为是相应属性的默认值。 即当某个要输出的POJO属性值与默认值相同时，该属性将被忽略而不会输出到JSON中。
• 当键值是PropertyOutputter的实现类时，键值代表一个子属性的输出器。 此时系统会将该属性的输出任务分派给这个子输出器。
• 当键值是VirtualPropertyOutputter的实现类时，键值代表一个虚拟属性的输出器。 虚拟属性是指并不一定真的存在于要输出的Java对象中的属性，只是我们希望在进行输出时输出这样一个属性值。
• 字符串"#default"是一个特殊的默认值，并且对于不同数据类型的属性而言"#default"又代表不同含义：
  • 对String而言"#default"表示null或""。
  • 对boolean而言"#default"表示false。
  • 对int、long、float、double等而言"#default"表示0。
  • 对其他数据类型而言"#default"表示null。
• 字符串"#ignore"是一个特殊的值，表示忽略该属性的输出操作。

isEscapeable

protected boolean isEscapeable(OutputContext context)

output

public void output(java.lang.Object object,
          OutputContext context)
            throws java.lang.Exception

Description copied from interface: Outputter

输出组件。

Specified by:

output in interface Outputter

Parameters:

object - 要输出的对象。

context - 输出上下文。

Throws:

java.lang.Exception

outputObject

protected void outputObject(java.lang.Object object,
                OutputContext context)
                     throws java.io.IOException,
                            java.lang.Exception

将一个Java的POJO对象输出成为JSON对象。

Throws:

java.io.IOException

java.lang.Exception

outputObjectProperties

protected void outputObjectProperties(java.lang.Object object,
                          OutputContext context)
                               throws java.lang.Exception

输出一个Java的POJO对象中在#getConfigProperties()配置过的各个POJO属性。

Throws:

java.lang.Exception