com.neeve.rog
Interface IRogJsonizable

public interface IRogJsonizable

Represents an ROG node that can be converted to a JSON string.

Threading:

Queue nodes are not safe for concurrent access by multiple threads.

Method Summary

String	toJsonString() Get a JSON representation of an ROG entity
String	toJsonString(boolean includeMetadata, String metadataObjectName, String dataObjectName) Get a full JSON representation of an ROG entity

Method Detail

toJsonString

String toJsonString(boolean includeMetadata,
                    String metadataObjectName,
                    String dataObjectName)

Get a full JSON representation of an ROG entity

Parameters:

includeMetadata - Specify this parameter for the ROG entity metadata to also be included in the JSON output. If included, the entire ROG entity object is treated as a composite object containing a nested metadata object and a nested data object. The next two parameters metadataObjectName and dataObjectName specify the names of the nested objects as they will appear in the output JSON string.

metadataObjectName - The name of the nested metadata object as it will appear in the output JSON string. A value of null will default to using 'metadata' as the nested object name.

dataObjectName - The name of the nested data object as it will appear in the output JSON string. A value of null will default to using 'data' as the nested object name.

toJsonString

String toJsonString()

Get a JSON representation of an ROG entity