com.ibm.websphere.objectgrid.plugins.io
Interface DataSerializer.UserReadable

All Superinterfaces:

DataSerializer

Enclosing interface:

DataSerializer

public static interface DataSerializer.UserReadable
extends DataSerializer

DataSerializers implement this optional interface to allow a customized human readable representation of a data object.

Since:

7.1.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer

DataSerializer.DataAttributeInflatable, DataSerializer.Identifiable, DataSerializer.SpecialValue, DataSerializer.UserReadable

Method Summary

String

toStringDataObject(DataObjectContext ctx, XsDataInputStream dataObjectInput) Return a user-readable form of the data object.

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer

inflateDataObject, serializeDataObject

Method Detail

toStringDataObject

String toStringDataObject(DataObjectContext ctx,
                          XsDataInputStream dataObjectInput)
                          throws IOException

Return a user-readable form of the data object. Implementations can choose to mask out sensitive data, such as passwords.

Do not store or use the data stream beyond the confines of this method call. The data stream is owned by the WebSphere eXtreme Scale framework and my be closed, pooled or reused as required.

Parameters:

ctx - the Context of the method call.

dataObjectInput - the data input stream to read the object, produced from DataSerializer.serializeDataObject(DataObjectContext, Object, XsDataOutputStream). Must not be null.

Returns:

the String representation of the data object or null if the default representation should be used.

Throws:

IOException - thrown if there is a problem reading the data.