com.supermap.services.rest.encoders

Class Encoder

java.lang.Object

com.supermap.services.rest.encoders.Encoder

Direct Known Subclasses:

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

public abstract class Encoder
extends java.lang.Object

${services_rest_encoders_Encoder_Title}

${services_rest_encoders_Encoder_Description}

Constructor Summary

Constructors

Constructor and Description
Encoder() ${services_rest_encoders_Encoder_constructor_Encoder_Title}

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.util.List<MediaType>	createSupportedMediaTypes() ${services_rest_encoders_Encoder_method_createSupportedMediaTypes_Title}
java.util.List<MediaType>	getSupportedMediaTypes() ${services_rest_encoders_Encoder_method_getSupportedMediaTypes_Title}
boolean	isEncodeAllow(MediaType mediaType) Determines whether the Encoder object matches the specified media type, that is, whether the Java object can be converted to a specified type of expression.
abstract Representation	toRepresentation(MediaType mediaType, java.lang.Object obj) ${services_rest_encoders_Encoder_method_toRepresentation_Title}

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoder

public Encoder()

${services_rest_encoders_Encoder_constructor_Encoder_Title}

${services_rest_encoders_Encoder_constructor_Encoder_Description}

Method Detail

getSupportedMediaTypes

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

${services_rest_encoders_Encoder_method_getSupportedMediaTypes_Title}

${services_rest_encoders_Encoder_method_getSupportedMediaTypes_Description}

Returns:

${services_rest_encoders_Encoder_method_getSupportedMediaTypes_return}

isEncodeAllow

public boolean isEncodeAllow(MediaType mediaType)

Determines whether the Encoder object matches the specified media type, that is, whether the Java object can be converted to a specified type of expression.

${services_rest_encoders_Encoder_method_isEncodeAllow_Description}

Parameters:

mediaType - The type of media, that is, the type of expression.

Returns:

Returns true if the Encoder object matches the specified media type, false otherwise.

createSupportedMediaTypes

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

${services_rest_encoders_Encoder_method_createSupportedMediaTypes_Title}

${services_rest_encoders_Encoder_method_createSupportedMediaTypes_Description}

Returns:

${services_rest_encoders_Encoder_method_createSupportedMediaTypes_return}

toRepresentation

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

${services_rest_encoders_Encoder_method_toRepresentation_Title}

${services_rest_encoders_Encoder_method_toRepresentation_Description}

Parameters:

mediaType - ${services_rest_encoders_Encoder_method_toRepresentation_param_mediaType}

obj - ${services_rest_encoders_Encoder_method_toRepresentation_param_obj}

Returns:

${services_rest_encoders_Encoder_method_toRepresentation_return}