in.dragonbra.javasteam.types

Class MessageObject

java.lang.Object

in.dragonbra.javasteam.types.MessageObject

Direct Known Subclasses:

ChatMemberInfo

public class MessageObject
extends java.lang.Object

Represents a KeyValue backed MessageObject structure, which are often sent by the Steam servers.

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyValue	keyValues

Constructor Summary

Constructors

Constructor and Description
MessageObject() Initializes a new instance of the MessageObject class with an empty inner KeyValues.
MessageObject(KeyValue keyValues) Initializes a new instance of the MessageObject class, using the provided KeyValues object.

Method Summary

Modifier and Type	Method and Description
boolean	readFromStream(java.io.InputStream stream) Populates this MessageObject instance from the data inside the given stream.
void	writeToStream(java.io.OutputStream stream) Writes this MessageObject instance to the given stream.

Methods inherited from class java.lang.Object

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

Field Detail

keyValues

protected KeyValue keyValues

Constructor Detail

MessageObject

public MessageObject(KeyValue keyValues)

Initializes a new instance of the MessageObject class, using the provided KeyValues object.

Parameters:

keyValues - The KeyValue backing store for this message object.

MessageObject

public MessageObject()

Initializes a new instance of the MessageObject class with an empty inner KeyValues.

Method Detail

readFromStream

public boolean readFromStream(java.io.InputStream stream)
                       throws java.io.IOException

Populates this MessageObject instance from the data inside the given stream.

Parameters:

stream - The stream to load data from.

Returns:

true on success; otherwise, false.

Throws:

java.io.IOException - IO exception during reading from the stream

writeToStream

public void writeToStream(java.io.OutputStream stream)
                   throws java.io.IOException

Writes this MessageObject instance to the given stream.

Parameters:

stream - The stream to write to.

Throws:

java.io.IOException - IO exception during writing to the stream