com.emphysic.myriad.network.messages

Class ImmutableMessage

java.lang.Object

com.emphysic.myriad.network.messages.ImmutableMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DatasetMessage, FileMessage, ROIMessage, ShutdownMessage

public abstract class ImmutableMessage
extends java.lang.Object
implements java.io.Serializable

ImmutableMessage - base class for Myriad messages. Created by ccoughlin on 9/28/2016.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	metadata Metadata

Constructor Summary

Constructors

Constructor and Description
ImmutableMessage(java.lang.String metadata)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	genMetadata(ImmutableMessage orig, java.lang.String key, java.lang.String val) Convenience function to create a new metadata String from a message's metadata and a new key=val pair.
java.lang.String	genMetadata(java.lang.String key, java.lang.String val) Convenience function to create a new metadata String from this message's metadata and a new key=val pair.
static java.lang.String	genMetadataEntry(java.lang.String key, java.lang.String val) Convenience function to generate a key=val pair.
java.lang.String	getMetadata() Retrieves the metadata
static java.util.Map<java.lang.String,java.lang.String>	getMetadata(java.lang.String mData) Convenience function to split metadata of the form &key1=val1&key2=val2...

Methods inherited from class java.lang.Object

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

Field Detail

metadata

final java.lang.String metadata

Metadata

Constructor Detail

ImmutableMessage

ImmutableMessage(java.lang.String metadata)

Method Detail

getMetadata

public java.lang.String getMetadata()

Retrieves the metadata

Returns:

metadata associated with this payload, or null if none

getMetadata

public static java.util.Map<java.lang.String,java.lang.String> getMetadata(java.lang.String mData)

Convenience function to split metadata of the form &key1=val1&key2=val2... into a Map

Parameters:

mData - original metadata

Returns:

key:value map of metadata

genMetadata

public java.lang.String genMetadata(java.lang.String key,
                                    java.lang.String val)

Convenience function to create a new metadata String from this message's metadata and a new key=val pair. This instance's metadata is not modified.

Parameters:

key - key

val - value

Returns:

new metadata String of the form this.getMetadata();&key=val

genMetadata

public static java.lang.String genMetadata(ImmutableMessage orig,
                                           java.lang.String key,
                                           java.lang.String val)

Convenience function to create a new metadata String from a message's metadata and a new key=val pair. The original message is not modified.

Parameters:

orig - metadata of existing metadata

key - key

val - value

Returns:

String of the form orig.getMetadata()&key=val

genMetadataEntry

public static java.lang.String genMetadataEntry(java.lang.String key,
                                                java.lang.String val)

Convenience function to generate a key=val pair.

Parameters:

key - key

val - value

Returns:

String of the form key=val