com.supermap.services.rest.encoders

类 Encoder

java.lang.Object

com.supermap.services.rest.encoders.Encoder

直接已知子类:

FastJsonEncoder, GeoRSSEncoder, ImageEncoder, JsonEncoder, KMLEncoder, ObjectStreamEncoder, SceneEncoder, StreamEncoder, TemplateEncoder, WKTEncoder, XMLEncoder, YamlEncoder

public abstract class Encoder
extends java.lang.Object

资源表述类。

构造器概要

构造器

构造器和说明
Encoder() 构造函数。

方法概要

方法

限定符和类型	方法和说明
protected abstract java.util.List<MediaType>	createSupportedMediaTypes() 创建支持的表述格式列表。
java.util.List<MediaType>	getSupportedMediaTypes() 获取资源支持的表述格式，即 MIME 类型。
boolean	isEncodeAllow(MediaType mediaType) 判断该 Encoder 对象是否与指定媒体类型匹配，即能否将 Java 对象转换成指定类型的表述。
abstract Representation	toRepresentation(MediaType mediaType, java.lang.Object obj) 将对象序列化为表述。

从类继承的方法 java.lang.Object

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

构造器详细资料

Encoder

public Encoder()

构造函数。

初始化 Encoder 对象，创建支持的类型，并判断当前请求是否属于调试模式。

方法详细资料

getSupportedMediaTypes

public java.util.List<MediaType> getSupportedMediaTypes()

获取资源支持的表述格式，即 MIME 类型。

返回:

支持的 MIME 类型列表。

isEncodeAllow

public boolean isEncodeAllow(MediaType mediaType)

判断该 Encoder 对象是否与指定媒体类型匹配，即能否将 Java 对象转换成指定类型的表述。

参数:

mediaType - 媒体类型，即表述的类型。

返回:

如果 Encoder 对象与制定媒体类型匹配，返回 true，否则，返回 false。

createSupportedMediaTypes

protected abstract java.util.List<MediaType> createSupportedMediaTypes()

创建支持的表述格式列表。

用户扩展一个 Encoder 时，需要指定该 Encoder 支持将格式化的对象转换为什么媒体类型的表述。

返回:

该 Encoder 对象支持的表述的媒体类型列表。

toRepresentation

public abstract Representation toRepresentation(MediaType mediaType,
                              java.lang.Object obj)

将对象序列化为表述。

参数:

mediaType - 表述的媒体类型。

obj - 欲转换的 Java 对象。

返回:

指定格式的 Java 对象的表述。