public final class MessageCollection extends Object implements Serializable, Comparable<MessageCollection>
Modifier and Type | Class and Description |
---|---|
static class |
MessageCollection.MappingXdiEntityMessageIterator |
Modifier | Constructor and Description |
---|---|
protected |
MessageCollection(MessageEnvelope messageEnvelope,
XdiEntityCollection xdiEntityCollection) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(MessageCollection other) |
Message |
createMessage()
Creates a new XDI message in this XDI message collection.
|
Message |
createMessage(long index)
Creates a new XDI message in this XDI message collection.
|
void |
deleteMessages()
Deletes all messages from this message collection.
|
boolean |
equals(Object object) |
static MessageCollection |
fromMessageEnvelopeAndXdiEntityCollection(MessageEnvelope messageEnvelope,
XdiEntityCollection xdiEntityCollection)
Factory method that creates an XDI message collection bound to a given XDI entity collection.
|
static MessageCollection |
fromXdiEntityCollection(XdiEntityCollection xdiEntityCollection)
Factory method that creates an XDI message collection bound to a given XDI entity collection.
|
ContextNode |
getContextNode()
Returns the underlying context node to which this XDI message collection is bound.
|
long |
getMessageCount()
Returns the number of messages in the message collection.
|
MessageEnvelope |
getMessageEnvelope()
Returns the XDI message envelope to which this XDI message collection belongs.
|
ReadOnlyIterator<Message> |
getMessages()
Returns all messages in this message collection.
|
long |
getOperationCount()
Returns the number of operations in all messages of the message envelope.
|
ReadOnlyIterator<Operation> |
getOperations()
Returns all operations in this message collection.
|
ContextNode |
getSender()
Returns the sender of the message collection.
|
XDIAddress |
getSenderXDIAddress()
Returns the sender address of the message collection.
|
XdiEntityCollection |
getXdiEntityCollection()
Returns the underlying XDI entity class to which this XDI message collection is bound.
|
int |
hashCode() |
static boolean |
isValid(XdiEntityCollection xdiEntityCollection)
Checks if an XDI entity class is a valid XDI message collection.
|
String |
toString() |
protected MessageCollection(MessageEnvelope messageEnvelope, XdiEntityCollection xdiEntityCollection)
public static boolean isValid(XdiEntityCollection xdiEntityCollection)
xdiEntityCollection
- The XDI entity class to check.public static MessageCollection fromMessageEnvelopeAndXdiEntityCollection(MessageEnvelope messageEnvelope, XdiEntityCollection xdiEntityCollection)
messageEnvelope
- The XDI message envelope to which this XDI message collection belongs.xdiEntityCollection
- The XDI entity class that is an XDI message collection.public static MessageCollection fromXdiEntityCollection(XdiEntityCollection xdiEntityCollection)
xdiEntityCollection
- The XDI entity class that is an XDI message collection.public MessageEnvelope getMessageEnvelope()
public XdiEntityCollection getXdiEntityCollection()
public ContextNode getContextNode()
public ContextNode getSender()
public XDIAddress getSenderXDIAddress()
public Message createMessage()
public Message createMessage(long index)
index
- Index in an ordered collection.public ReadOnlyIterator<Message> getMessages()
public void deleteMessages()
public ReadOnlyIterator<Operation> getOperations()
public long getMessageCount()
public long getOperationCount()
public int compareTo(MessageCollection other)
compareTo
in interface Comparable<MessageCollection>
Copyright © 2017. All rights reserved.