XDIWriter (xdi2-core 0.7.2 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractXDIWriter, XDIDisplayWriter, XDIHTMLWriter, XDIJSONPARSEWriter, XDIJSONQuadWriter, XDIJSONTREEWriter, XDIJSONTripleWriter, XDIJSONWriter, XDIKeyValueWriter
```
public interface XDIWriter
extends Serializable
```
Provides methods for writing an XDI graph.

Author:

markus

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getFileExtension()` Returns the file extension of this XDIWriter, e.g.
`String`	`getFormat()` Returns the format this XDIWriter can write, e.g.
`MimeType`	`getMimeType()` Returns the mime type this XDIWriter can write, e.g.
`boolean`	`supportsFileExtension(String fileExtension)` Checks if a given file extension is supported.
`boolean`	`supportsFormat(String format)` Checks if a given format is supported.
`boolean`	`supportsMimeType(MimeType mimeType)` Checks if a given mime type is supported.
`OutputStream`	`write(ContextNode contextNode, OutputStream stream)` Writes an XDI context node to a byte stream.
`Writer`	`write(ContextNode contextNode, Writer writer)` Writes an XDI context node to a character stream.
`OutputStream`	`write(Graph graph, OutputStream stream)` Writes an XDI graph to a byte stream.
`Writer`	`write(Graph graph, Writer writer)` Writes an XDI graph to a character stream.

- Method Detail
  - write
```
Writer write(Graph graph,
           Writer writer)
             throws IOException
```
    Writes an XDI graph to a character stream.
    
    Parameters:
    graph - A graph that will be written to the stream.
    writer - The character stream to write to.
    
    Returns:
    The character stream.
    
    Throws:
    
    IOException
  - write
```
OutputStream write(Graph graph,
                 OutputStream stream)
                   throws IOException
```
    Writes an XDI graph to a byte stream.
    
    Parameters:
    graph - A graph that will be written to the stream.
    stream - The byte stream to write to.
    
    Returns:
    The byte stream.
    
    Throws:
    
    IOException
  - write
```
Writer write(ContextNode contextNode,
           Writer writer)
             throws IOException
```
    Writes an XDI context node to a character stream.
    
    Parameters:
    contextNode - A context node that will be written to the stream.
    writer - The character stream to write to.
    
    Returns:
    The character stream.
    
    Throws:
    
    IOException
  - write
```
OutputStream write(ContextNode contextNode,
                 OutputStream stream)
                   throws IOException
```
    Writes an XDI context node to a byte stream.
    
    Parameters:
    graph - A context node that will be written to the stream.
    stream - The byte stream to write to.
    
    Returns:
    The byte stream.
    
    Throws:
    
    IOException
  - getFormat
```
String getFormat()
```
    Returns the format this XDIWriter can write, e.g.
    - XDI/JSON
    - XDI DISPLAY
    Returns:
    The format of this XDIWriter.
  - getFileExtension
```
String getFileExtension()
```
    Returns the file extension of this XDIWriter, e.g.
    - .json
    - .xdi
    Returns:
    The file extension of this XDIWriter.
  - getMimeType
```
MimeType getMimeType()
```
    Returns the mime type this XDIWriter can write, e.g.
    - text/plain
    - application/xdi+json
    Returns:
    The mime type of this XDIWriter.
  - supportsFormat
```
boolean supportsFormat(String format)
```
    Checks if a given format is supported.
    
    Returns:
    True, if supported.
  - supportsFileExtension
```
boolean supportsFileExtension(String fileExtension)
```
    Checks if a given file extension is supported.
    
    Returns:
    True, if supported.
  - supportsMimeType
```
boolean supportsMimeType(MimeType mimeType)
```
    Checks if a given mime type is supported.
    
    Returns:
    True, if supported.

Interface XDIWriter

Method Summary

Method Detail

write

write

write

write

getFormat

getFileExtension

getMimeType

supportsFormat

supportsFileExtension

supportsMimeType