MessageEnvelope (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.MessageEnvelope

All Implemented Interfaces:

Serializable, Comparable<MessageEnvelope>
```
public class MessageEnvelope
extends Object
implements Serializable, Comparable<MessageEnvelope>
```
An XDI message envelope, represented as a graph.

Author:

markus

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MessageEnvelope.MappingXdiEntityCollectionMessageCollectionIterator

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageEnvelope.MappingXdiEntityCollectionMessageCollectionIterator`

Field Summary

Fields
Modifier and Type Field and Description

protected Graph graph

protected static MemoryGraphFactory graphFactory

Fields
Modifier and Type	Field and Description
`protected Graph`	`graph`
`protected static MemoryGraphFactory`	`graphFactory`

Constructor Summary

Constructors
Modifier Constructor and Description

MessageEnvelope()

protected MessageEnvelope(Graph graph)

Constructors
Modifier	Constructor and Description
	`MessageEnvelope()`
`protected`	`MessageEnvelope(Graph graph)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(MessageEnvelope other)`
`Message`	`createMessage(XDIAddress senderXDIAddress)` Creates a new XDI message in this XDI message envelope for a given sender.
`Message`	`createMessage(XDIAddress senderXDIAddress, long index)` Creates a new XDI message in this XDI message envelope for a given sender.
`void`	`deleteMessageCollections()` Deletes all message collections from this message envelope.
`boolean`	`equals(Object object)`
`static MessageEnvelope`	`fromGraph(Graph graph)` Factory method that creates an XDI message envelope bound to a given graph.
`static MessageEnvelope`	`fromOperationXDIAddressAndTargetXDIAddress(XDIAddress operationXDIAddress, XDIAddress targetXDIAddress)` Factory method that creates an XDI message envelope bound to a given graph.
`static MessageEnvelope`	`fromOperationXDIAddressAndTargetXDIAddressOrTargetXDIStatement(XDIAddress operationXDIAddress, String targetXDIAddressOrTargetStatement)` Factory method that creates an XDI message envelope bound to a given graph.
`static MessageEnvelope`	`fromOperationXDIAddressAndTargetXDIStatements(XDIAddress operationXDIAddress, Iterator<XDIStatement> targetXDIStatements)` Factory method that creates an XDI message envelope bound to a given graph.
`Graph`	`getGraph()` Returns the underlying graph to which this XDI message envelope is bound.
`MessageCollection`	`getMessageCollection(XDIAddress senderXDIAddress, boolean create)` Returns an existing XDI message collection in this XDI message envelope, or creates a new one.
`long`	`getMessageCollectionCount()` Returns the number of message collections in the message envelope.
`ReadOnlyIterator<MessageCollection>`	`getMessageCollections()` Returns all message collections in this message envelope.
`long`	`getMessageCount()` Returns the number of messages in the message envelope.
`ReadOnlyIterator<Message>`	`getMessages()` Returns all messages in this message envelope.
`ReadOnlyIterator<Message>`	`getMessages(XDIAddress senderXDIAddress)` Finds messages with a given sender in this message envelope.
`long`	`getOperationCount()` Returns the number of operations in all messages of the message envelope.
`ReadOnlyIterator<Operation>`	`getOperations()` Returns all operations in this message envelope.
`int`	`hashCode()`
`static boolean`	`isValid(Graph graph)` Checks if a graph is a valid XDI message envelope.
`String`	`toString()`

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

- Field Detail
  - graphFactory
```
protected static final MemoryGraphFactory graphFactory
```
  - graph
```
protected Graph graph
```
- Constructor Detail
  - MessageEnvelope
```
protected MessageEnvelope(Graph graph)
```
  - MessageEnvelope
```
public MessageEnvelope()
```
- Method Detail
  - isValid
```
public static boolean isValid(Graph graph)
```
    Checks if a graph is a valid XDI message envelope.
    
    Parameters:
    graph - The graph to check.
    
    Returns:
    True if the graph is a valid XDI message envelope.
  - fromGraph
```
public static MessageEnvelope fromGraph(Graph graph)
```
    Factory method that creates an XDI message envelope bound to a given graph.
    
    Parameters:
    graph - The graph that is an XDI message envelope.
    
    Returns:
    The XDI message envelope.
  - fromOperationXDIAddressAndTargetXDIAddress
```
public static MessageEnvelope fromOperationXDIAddressAndTargetXDIAddress(XDIAddress operationXDIAddress,
                                                         XDIAddress targetXDIAddress)
```
    Factory method that creates an XDI message envelope bound to a given graph.
    
    Parameters:
    operationXDIAddress - The operation XRI to use for the new operation.
    targetXDIAddress - The target address to which the operation applies.
    
    Returns:
    The XDI message envelope.
  - fromOperationXDIAddressAndTargetXDIStatements
```
public static MessageEnvelope fromOperationXDIAddressAndTargetXDIStatements(XDIAddress operationXDIAddress,
                                                            Iterator<XDIStatement> targetXDIStatements)
```
    Factory method that creates an XDI message envelope bound to a given graph.
    
    Parameters:
    operationXDIAddress - The operation XRI to use for the new operation.
    targetXDIStatements - The target statements to which the operation applies.
    
    Returns:
    The XDI message envelope.
  - fromOperationXDIAddressAndTargetXDIAddressOrTargetXDIStatement
```
public static final MessageEnvelope fromOperationXDIAddressAndTargetXDIAddressOrTargetXDIStatement(XDIAddress operationXDIAddress,
                                                                             String targetXDIAddressOrTargetStatement)
```
    Factory method that creates an XDI message envelope bound to a given graph.
    
    Parameters:
    operationXDIAddress - The operation XRI to use for the new operation.
    targetXDIAddressOrTargetStatement - The target address or target statement to which the operation applies.
    
    Returns:
    The XDI message envelope.
  - getGraph
```
public Graph getGraph()
```
    Returns the underlying graph to which this XDI message envelope is bound.
    
    Returns:
    A graph that represents the XDI message envelope.
  - getMessageCollection
```
public MessageCollection getMessageCollection(XDIAddress senderXDIAddress,
                                     boolean create)
```
    Returns an existing XDI message collection in this XDI message envelope, or creates a new one.
    
    Parameters:
    senderXDIAddress - The sender.
    create - Whether to create an XDI message collection if it does not exist.
    
    Returns:
    The existing or newly created XDI message collection.
  - getMessageCollections
```
public ReadOnlyIterator<MessageCollection> getMessageCollections()
```
    Returns all message collections in this message envelope.
    
    Returns:
    All message collections in the envelope.
  - deleteMessageCollections
```
public void deleteMessageCollections()
```
    Deletes all message collections from this message envelope.
  - getMessages
```
public ReadOnlyIterator<Message> getMessages()
```
    Returns all messages in this message envelope.
    
    Returns:
    All messages contained in the envelope.
  - getMessages
```
public ReadOnlyIterator<Message> getMessages(XDIAddress senderXDIAddress)
```
    Finds messages with a given sender in this message envelope.
    
    Parameters:
    senderXDIAddress - The sender to look for.
    
    Returns:
    The messages.
  - getOperations
```
public ReadOnlyIterator<Operation> getOperations()
```
    Returns all operations in this message envelope.
    
    Returns:
    All messages contained in the envelope.
  - getMessageCollectionCount
```
public long getMessageCollectionCount()
```
    Returns the number of message collections in the message envelope.
  - getMessageCount
```
public long getMessageCount()
```
    Returns the number of messages in the message envelope.
  - getOperationCount
```
public long getOperationCount()
```
    Returns the number of operations in all messages of the message envelope.
  - createMessage
```
public Message createMessage(XDIAddress senderXDIAddress)
```
    Creates a new XDI message in this XDI message envelope for a given sender.
    
    Parameters:
    senderXDIAddress - The sender.
    
    Returns:
    The newly created XDI message.
  - createMessage
```
public Message createMessage(XDIAddress senderXDIAddress,
                    long index)
```
    Creates a new XDI message in this XDI message envelope for a given sender.
    
    Parameters:
    senderXDIAddress - The sender.
    index - Index in an ordered collection.
    
    Returns:
    The newly created XDI message.
  - 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(MessageEnvelope other)
```
    Specified by:
    
    compareTo in interface Comparable<MessageEnvelope>

Class MessageEnvelope

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

graphFactory

graph

Constructor Detail

MessageEnvelope

MessageEnvelope

Method Detail

isValid

fromGraph

fromOperationXDIAddressAndTargetXDIAddress

fromOperationXDIAddressAndTargetXDIStatements

fromOperationXDIAddressAndTargetXDIAddressOrTargetXDIStatement

getGraph

getMessageCollection

getMessageCollections

deleteMessageCollections

getMessages

getMessages

getOperations

getMessageCollectionCount

getMessageCount

getOperationCount

createMessage

createMessage

toString

equals

hashCode

compareTo