MessageResult (xdi2-messaging 0.7.2 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- xdi2.messaging.MessageResult

All Implemented Interfaces:

Serializable, Comparable<MessageResult>

Direct Known Subclasses:

ErrorMessageResult
```
public class MessageResult
extends Object
implements Serializable, Comparable<MessageResult>
```
An XDI message result, represented as a graph.

Author:

markus

See Also:
Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

MessageResult()

protected MessageResult(Graph graph)

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(MessageResult other)`
`boolean`	`equals(Object object)`
`static MessageResult`	`fromGraph(Graph graph)` Factory method that creates an XDI message result bound to a given graph.
`Graph`	`getGraph()` Returns the underlying graph to which this XDI message result is bound.
`int`	`hashCode()`
`boolean`	`isEmpty()` Check if the message result is empty.
`static boolean`	`isValid(Graph graph)` Checks if a graph is a valid XDI message result.
`String`	`toString()`

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

- Constructor Detail
  - MessageResult
```
protected MessageResult(Graph graph)
```
  - MessageResult
```
public MessageResult()
```
- Method Detail
  - isValid
```
public static boolean isValid(Graph graph)
```
    Checks if a graph is a valid XDI message result.
    
    Parameters:
    graph - The graph to check.
    
    Returns:
    True if the graph is a valid XDI message result.
  - fromGraph
```
public static MessageResult fromGraph(Graph graph)
```
    Factory method that creates an XDI message result bound to a given graph.
    
    Parameters:
    graph - The graph that is an XDI message result.
    
    Returns:
    The XDI message result.
  - getGraph
```
public Graph getGraph()
```
    Returns the underlying graph to which this XDI message result is bound.
    
    Returns:
    A graph that contains XDI messaging data.
  - isEmpty
```
public boolean isEmpty()
```
    Check if the message result is empty.
    
    Returns:
    True, if the underlying graph contains no context nodes.
  - 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(MessageResult other)
```
    Specified by:
    
    compareTo in interface Comparable<MessageResult>

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015. All Rights Reserved.