com.vmware.vapi.protocol.common.json

Class JsonConverter

java.lang.Object

com.vmware.vapi.protocol.common.json.JsonConverter

public class JsonConverter
extends java.lang.Object

Converter which encodes DataValue to and from simple JSON representation.

This is the JSON representation which is used in REST rendering of the APIs.

Constructor Summary

Constructors

Constructor and Description
JsonConverter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	fromDataValue(DataValue value) This method converts the DataValue object to a JSON string.
void	fromDataValue(DataValue value, java.io.OutputStream outputStream) This method converts the DataValue Object to a ByteArrayOutputStream.
DataValue	toDataValue(java.io.InputStream input) This method converts a JSON passed as an InputStream into a concrete DataValue object.
DataValue	toDataValue(java.lang.String json) This method converts a JSON string representation into a concrete DataValue object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonConverter

public JsonConverter()

Method Detail

toDataValue

public DataValue toDataValue(java.lang.String json)

This method converts a JSON string representation into a concrete DataValue object.

Parameters:

json - a String representation of a JSON

Returns:

Returns the concrete DataValue

Throws:

CoreException - if the provided InputStream cannot be deserialized

toDataValue

public DataValue toDataValue(java.io.InputStream input)

This method converts a JSON passed as an InputStream into a concrete DataValue object.

Parameters:

input - the InputStream we read the JSON from, which will be closed before the method returns or throws a CoreException

Returns:

Returns the concrete DataValue

Throws:

CoreException - if the provided InputStream cannot be deserialized

fromDataValue

public java.lang.String fromDataValue(DataValue value)

This method converts the DataValue object to a JSON string.

Parameters:

value - a DataValue object we want to convert to JSON

Returns:

the JSON string representation of a DataValue

Throws:

CoreException - if the provided DataValue cannot be serialized

fromDataValue

public void fromDataValue(DataValue value,
                          java.io.OutputStream outputStream)

This method converts the DataValue Object to a ByteArrayOutputStream.

Parameters:

value - a DataValue

outputStream - stream to write the serialized result to, which will be closed before the method returns or throws a CoreException

Throws:

CoreException - if the provided DataValue cannot be serialized