MessageCollection (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.MessageCollection

All Implemented Interfaces:

Serializable, Comparable<MessageCollection>
```
public final class MessageCollection
extends Object
implements Serializable, Comparable<MessageCollection>
```
An XDI message collection, represented as a context node.

Author:

markus

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MessageCollection.MappingXdiEntityMessageIterator

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageCollection.MappingXdiEntityMessageIterator`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MessageCollection(MessageEnvelope messageEnvelope, XdiEntityCollection xdiEntityCollection)

Constructors
Modifier	Constructor and Description
`protected`	`MessageCollection(MessageEnvelope messageEnvelope, XdiEntityCollection xdiEntityCollection)`

Method Summary

Methods
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`	`fromMessageEnvelopeAndXdiEntityClass(MessageEnvelope messageEnvelope, XdiEntityCollection xdiEntityCollection)` Factory method that creates an XDI message collection bound to a given XDI entity class.
`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()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MessageCollection
```
protected MessageCollection(MessageEnvelope messageEnvelope,
                 XdiEntityCollection xdiEntityCollection)
```
- Method Detail
  - isValid
```
public static boolean isValid(XdiEntityCollection xdiEntityCollection)
```
    Checks if an XDI entity class is a valid XDI message collection.
    
    Parameters:
    xdiEntityCollection - The XDI entity class to check.
    
    Returns:
    True if the XDI entity class is a valid XDI message collection.
  - fromMessageEnvelopeAndXdiEntityClass
```
public static MessageCollection fromMessageEnvelopeAndXdiEntityClass(MessageEnvelope messageEnvelope,
                                                     XdiEntityCollection xdiEntityCollection)
```
    Factory method that creates an XDI message collection bound to a given XDI entity class.
    
    Parameters:
    messageEnvelope - The XDI message envelope to which this XDI message collection belongs.
    xdiEntityCollection - The XDI entity class that is an XDI message collection.
    
    Returns:
    The XDI message collection.
  - getMessageEnvelope
```
public MessageEnvelope getMessageEnvelope()
```
    Returns the XDI message envelope to which this XDI message collection belongs.
    
    Returns:
    An XDI message envelope.
  - getXdiEntityCollection
```
public XdiEntityCollection getXdiEntityCollection()
```
    Returns the underlying XDI entity class to which this XDI message collection is bound.
    
    Returns:
    An XDI entity class that represents the XDI message collection.
  - getContextNode
```
public ContextNode getContextNode()
```
    Returns the underlying context node to which this XDI message collection is bound.
    
    Returns:
    A context node that represents the XDI message collection.
  - getSender
```
public ContextNode getSender()
```
    Returns the sender of the message collection.
    
    Returns:
    The sender of the message collection.
  - getSenderXDIAddress
```
public XDIAddress getSenderXDIAddress()
```
    Returns the sender address of the message collection.
    
    Returns:
    The sender adddress of the message collection.
  - createMessage
```
public Message createMessage()
```
    Creates a new XDI message in this XDI message collection.
    
    Returns:
    The newly created XDI message.
  - createMessage
```
public Message createMessage(long index)
```
    Creates a new XDI message in this XDI message collection.
    
    Parameters:
    index - Index in an ordered collection.
    
    Returns:
    The newly created XDI message.
  - getMessages
```
public ReadOnlyIterator<Message> getMessages()
```
    Returns all messages in this message collection.
    
    Returns:
    All messages contained in the collection.
  - deleteMessages
```
public void deleteMessages()
```
    Deletes all messages from this message collection.
  - getOperations
```
public ReadOnlyIterator<Operation> getOperations()
```
    Returns all operations in this message collection.
    
    Returns:
    All operations contained in the collection.
  - getMessageCount
```
public long getMessageCount()
```
    Returns the number of messages in the message collection.
  - getOperationCount
```
public long getOperationCount()
```
    Returns the number of operations in all messages of the message envelope.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(MessageCollection other)
```
    Specified by:
    
    compareTo in interface Comparable<MessageCollection>

Class MessageCollection

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageCollection

Method Detail

isValid

fromMessageEnvelopeAndXdiEntityClass

getMessageEnvelope

getXdiEntityCollection

getContextNode

getSender

getSenderXDIAddress

createMessage

createMessage

getMessages

deleteMessages

getOperations

getMessageCount

getOperationCount

toString

equals

hashCode

compareTo