Interface Encoder
-
- All Known Implementing Classes:
BinaryEncoder
,GenericJbossMarshallerEncoder
,GlobalMarshallerEncoder
,IdentityEncoder
,JavaSerializationEncoder
,MarshallerEncoder
,UTF8Encoder
public interface Encoder
Used to convert data between read/write format and storage format.- Since:
- 9.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Object
fromStorage(Object content)
Convert from storage format to the read/write format.MediaType
getStorageFormat()
Returns theMediaType
produced by this encoder or null if the storage format is not known.short
id()
Each encoder is associated with an unique id in order to optimize serialization.boolean
isStorageFormatFilterable()
Object
toStorage(Object content)
Convert data in the read/write format to the storage format.
-
-
-
Method Detail
-
toStorage
Object toStorage(Object content)
Convert data in the read/write format to the storage format.- Parameters:
content
- data to be converted, never null.- Returns:
- Object in the storage format.
-
fromStorage
Object fromStorage(Object content)
Convert from storage format to the read/write format.- Parameters:
content
- data as stored in the cache, never null.- Returns:
- data in the read/write format
-
isStorageFormatFilterable
boolean isStorageFormatFilterable()
- Returns:
- if true, will perform stream and related operation in the storage format.
-
getStorageFormat
MediaType getStorageFormat()
Returns theMediaType
produced by this encoder or null if the storage format is not known.
-
id
short id()
Each encoder is associated with an unique id in order to optimize serialization. Known ids are kept inEncoderIds
.- Returns:
- unique identifier for this encoder
-
-