XDIReader (xdi2-core 0.7.2 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractXDIReader, AutoReader, XDIDisplayReader, XDIJSONQuadReader, XDIJSONReader, XDIRawJSONReader
```
public interface XDIReader
extends Serializable
```
Provides methods for reading an XDI graph.

Author:

markus

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getFileExtension()` Returns the file extension of this XDIReader, e.g.
`String`	`getFormat()` Returns the format this XDIReader can read, e.g.
`MimeType`	`getMimeType()` Returns the mime type this XDIReader can read, e.g.
`InputStream`	`read(Graph graph, InputStream stream)` Reads an XDI graph from a byte stream.
`Reader`	`read(Graph graph, Reader reader)` Reads an XDI graph from a character stream.
`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.

- Method Detail
  - read
```
Reader read(Graph graph,
          Reader reader)
            throws IOException,
                   Xdi2ParseException
```
    Reads an XDI graph from a character stream.
    
    Parameters:
    graph - A graph that will hold the read data.
    reader - A character stream from which to read.
    
    Returns:
    The character stream.
    
    Throws:
    
    IOException
    
    Xdi2ParseException
  - read
```
InputStream read(Graph graph,
               InputStream stream)
                 throws IOException,
                        Xdi2ParseException
```
    Reads an XDI graph from a byte stream.
    
    Parameters:
    graph - A graph that will hold the read data.
    stream - A byte stream from which to read.
    
    Returns:
    The byte stream.
    
    Throws:
    
    IOException
    
    Xdi2ParseException
  - getFormat
```
String getFormat()
```
    Returns the format this XDIReader can read, e.g.
    - XDI/JSON
    - XDI DISPLAY
    Returns:
    The format of this XDIReader.
  - getFileExtension
```
String getFileExtension()
```
    Returns the file extension of this XDIReader, e.g.
    - .xdi
    - .json
    Returns:
    The file extension of this XDIReader.
  - getMimeType
```
MimeType getMimeType()
```
    Returns the mime type this XDIReader can read, e.g.
    - text/plain
    - application/xdi+json
    Returns:
    The mime type of this XDIReader.
  - 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 XDIReader

Method Summary

Method Detail

read

read

getFormat

getFileExtension

getMimeType

supportsFormat

supportsFileExtension

supportsMimeType