com.supermap.services.rest.encoders

类 SwaggerUIEncoder

java.lang.Object

com.supermap.services.rest.encoders.Encoder

com.supermap.services.rest.encoders.TemplateEncoder

com.supermap.services.rest.encoders.SwaggerUIEncoder

所有已实现的接口:

javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

@Provider
public class SwaggerUIEncoder
extends TemplateEncoder

构造器概要

构造器

构造器和说明
SwaggerUIEncoder()

方法概要

方法

限定符和类型	方法和说明
boolean	isWriteable(java.lang.Class arg0, java.lang.reflect.Type arg1, java.lang.annotation.Annotation[] arg2, javax.ws.rs.core.MediaType arg3) 判断本表述生成器是否支持指定媒体类型的表述。
void	writeTo(java.lang.Object arg0, java.lang.Class arg1, java.lang.reflect.Type arg2, java.lang.annotation.Annotation[] arg3, javax.ws.rs.core.MediaType arg4, javax.ws.rs.core.MultivaluedMap arg5, java.io.OutputStream arg6) 生成指定媒体类型的 HTTP 响应。

从类继承的方法 com.supermap.services.rest.encoders.TemplateEncoder

computeTemplateName, createSupportedLanguages, createSupportedMediaTypes, createTemplate, getAllConfigs, getApplicationRootPath, getConfiguration, getLocLogger, getMessageManager, getParentResourceInfos, getProductType, getRepresentation, getServletID, getSize, getTemplateName, setExpectedLanguage, setExtendedUriInfo, setTemplateName, supportedMediaTypes, templateName, toRepresentation

从类继承的方法 com.supermap.services.rest.encoders.Encoder

getSupportedMediaTypes, isEncodeAllow

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

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

构造器详细资料

SwaggerUIEncoder

public SwaggerUIEncoder()

方法详细资料

writeTo

public void writeTo(java.lang.Object arg0,
           java.lang.Class arg1,
           java.lang.reflect.Type arg2,
           java.lang.annotation.Annotation[] arg3,
           javax.ws.rs.core.MediaType arg4,
           javax.ws.rs.core.MultivaluedMap arg5,
           java.io.OutputStream arg6)
             throws java.io.IOException,
                    javax.ws.rs.WebApplicationException

从类复制的说明: TemplateEncoder

生成指定媒体类型的 HTTP 响应。

指定者:

writeTo 在接口中 javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

覆盖:

writeTo 在类中 TemplateEncoder

参数:

arg0 - 要生成表述的对象。

arg1 - 要生成表述的对象对应的 Java 类。

arg2 - 要生成表述的对象的类型。

arg3 - 注记数组，资源中有这些注记的方法返回要写入的对象。

arg4 - HTTP 响应的媒体类型。

arg5 - HTTP 响应的消息头。

arg6 - HTTP 响应。

抛出:

java.io.IOException - 当读写过程出错时。

javax.ws.rs.WebApplicationException - 当 HTTP 响应出错时。

isWriteable

public boolean isWriteable(java.lang.Class arg0,
                  java.lang.reflect.Type arg1,
                  java.lang.annotation.Annotation[] arg2,
                  javax.ws.rs.core.MediaType arg3)

从类复制的说明: TemplateEncoder

判断本表述生成器是否支持指定媒体类型的表述。

指定者:

isWriteable 在接口中 javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

覆盖:

isWriteable 在类中 TemplateEncoder

参数:

arg0 - 要生成表述的对象。

arg1 - 指定的媒体类型。

arg2 - 注记数组，资源中有这些注记的方法返回要写入的对象。

arg3 - 预期响应的媒体类型。

返回:

如果本表述生成器支持指定的媒体类型，则返回 true，否则返回 false。