com.pega.pegarules.pub.clipboard.mapping

Interface ClipboardDataStreamMapper

public interface ClipboardDataStreamMapper

ClipboardDataStreamMapper provides API for deserializing and serializing the clipboard structure to data stream, for example JSON stream.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
void	deserialize(ClipboardPage page, java.io.Reader dataStreamSource) Populates the provided clipboard page with the contents in the data stream.
void	deserialize(ClipboardPage page, java.io.Reader dataStreamSource, EntityMap map) Populates the provided clipboard page with the contents in the data stream according to the mapping specified in the map parameter.
void	deserialize(ClipboardProperty property, java.io.Reader dataStreamSource) Populates the provided clipboard property with the contents in the data stream.
void	deserialize(ClipboardProperty property, java.io.Reader dataStreamSource, EntityMap map) Populates the provided clipboard property with the contents in the data stream according to the mapping specified in the map parameter.
EntityMapBuilder	getEntityMapBuilder() Use the EntityMetadataBuilder to build the EntityMap required for achieving custom deserialization/serialization
void	serialize(ClipboardPage page, java.io.Writer dataStreamTarget) Converts and writes the clipboard page contents into the provided data stream target.
void	serialize(ClipboardPage page, java.io.Writer dataStreamTarget, EntityMap map) Converts and writes the clipboard page contents into the provided data stream target according to the mapping specified in the map parameter.
void	serialize(ClipboardProperty property, java.io.Writer dataStreamTarget) Converts and writes the clipboard property contents into the provided data stream target.
void	serialize(ClipboardProperty property, java.io.Writer dataStreamTarget, EntityMap map) Converts and writes the clipboard property contents into the provided data stream target according to the mapping specified in the map parameter.

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

deserialize

void deserialize(ClipboardPage page,
                 java.io.Reader dataStreamSource)

Populates the provided clipboard page with the contents in the data stream. This method auto maps the data stream on to the clipboard page.

Parameters:

page -

dataStreamSource -

Throws:

java.lang.IllegalArgumentException - Invalid input for dataStreamSource

java.lang.IllegalStateException - Parsing input data entered an illegal state

PRRuntimeException - Runtime errors mapping the input

deserialize

void deserialize(ClipboardProperty property,
                 java.io.Reader dataStreamSource)

Populates the provided clipboard property with the contents in the data stream. Use this method if top level list (e.g. JSON arrays) need to be mapped to a clipboard page list.

This method auto maps the data stream on to the clipboard page.

Parameters:

property -

dataStreamSource -

Throws:

java.lang.IllegalArgumentException - Invalid input for dataStreamSource

java.lang.IllegalStateException - Parsing input data entered an illegal state

PRRuntimeException - Runtime errors mapping the input

deserialize

void deserialize(ClipboardPage page,
                 java.io.Reader dataStreamSource,
                 EntityMap map)

Populates the provided clipboard page with the contents in the data stream according to the mapping specified in the map parameter.

Use getEntityMapBuilder() to create a map.

Parameters:

page -

dataStreamSource -

map -

Throws:

java.lang.IllegalArgumentException - Invalid input for dataStreamSource

java.lang.IllegalStateException - Parsing input data entered an illegal state

PRRuntimeException - Runtime errors mapping the input

deserialize

void deserialize(ClipboardProperty property,
                 java.io.Reader dataStreamSource,
                 EntityMap map)

Populates the provided clipboard property with the contents in the data stream according to the mapping specified in the map parameter. Use this method if top level list (e.g. JSON arrays) need to be mapped to a clipboard page list.

Use getEntityMapBuilder() to create a map.

Parameters:

property -

dataStreamSource -

map -

Throws:

java.lang.IllegalArgumentException - Invalid input for dataStreamSource

java.lang.IllegalStateException - Parsing input data entered an illegal state

PRRuntimeException - Runtime errors mapping the input

serialize

void serialize(ClipboardPage page,
               java.io.Writer dataStreamTarget)

Converts and writes the clipboard page contents into the provided data stream target. This method auto maps the page contents on to the stream.

Parameters:

page -

dataStreamTarget -

Throws:

PRRuntimeException - runtime issues with data stream generation

serialize

void serialize(ClipboardProperty property,
               java.io.Writer dataStreamTarget)

Converts and writes the clipboard property contents into the provided data stream target. This method auto maps the page contents on to the stream. Use this method if a page list needs to be converted to a top level list (e.g. JSON array)

Parameters:

property -

dataStreamTarget -

Throws:

PRRuntimeException - runtime issues with data stream generation

serialize

void serialize(ClipboardPage page,
               java.io.Writer dataStreamTarget,
               EntityMap map)

Converts and writes the clipboard page contents into the provided data stream target according to the mapping specified in the map parameter.

Use getEntityMapBuilder() to create a map.

Parameters:

page -

dataStreamTarget -

map -

Throws:

PRRuntimeException - runtime issues with data stream generation

serialize

void serialize(ClipboardProperty property,
               java.io.Writer dataStreamTarget,
               EntityMap map)

Converts and writes the clipboard property contents into the provided data stream target according to the mapping specified in the map parameter. Use this method if a page list needs to be converted to a top level list (e.g. JSON array)

Use getEntityMapBuilder() to create a map.

Parameters:

property -

dataStreamTarget -

map -

Throws:

PRRuntimeException - runtime issues with data stream generation

getEntityMapBuilder

EntityMapBuilder getEntityMapBuilder()

Use the EntityMetadataBuilder to build the EntityMap required for achieving custom deserialization/serialization

Returns:

EntityMapBuilder to build entity map