org.ow2.util.auditreport.api
Interface IDisplayableType<TypeObject>

All Superinterfaces:

IEncodableType<TypeObject>

public interface IDisplayableType<TypeObject>
extends IEncodableType<TypeObject>

Interface which describing an encodable and displayable object.

Author:

Vincent Michaud

Method Summary

String	displayableToEncoded(Object strObject) Convert a displayable string to an encoded string.
Object	encodedToDisplayable(String encodedString) Convert an encoded string to a displayable string.

Methods inherited from interface org.ow2.util.auditreport.api.IEncodableType

fromString, toString

Method Detail

encodedToDisplayable

Object encodedToDisplayable(String encodedString)

Convert an encoded string to a displayable string.

Parameters:

encodedString - The encoded string

Returns:

A string representation of the object, or a list of string (in case of array, or complex objects) Each string must not contain new line characters. Returning a list of string can be used for this. Also, each string must not begin with a sequence of space.

displayableToEncoded

String displayableToEncoded(Object strObject)

Convert a displayable string to an encoded string.

Parameters:

strObject - The displayble object. The object can be a string or a list of string (in case of array, or complex objects). Each string does not contain new line characters.

Returns:

The new object