xdi2.core.io

Class AbstractXDIWriter

java.lang.Object

xdi2.core.io.AbstractXDIWriter

All Implemented Interfaces:

Serializable, XDIWriter

Direct Known Subclasses:

XDIDisplayWriter, XDIJSONPARSEWriter, XDIJSONQuadWriter, XDIJSONTREEWriter, XDIJSONTripleWriter, XDIJSONWriter, XDIJXDWriter, XDIKeyValueWriter, XDIRDFJSONLDWriter, XDIRDFTriGWriter

public abstract class AbstractXDIWriter
extends Object
implements XDIWriter

If you extend this class, you only have to implement write(Graph, Writer, Properties)

Author:

markus

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET
protected Properties	parameters

Constructor Summary

Constructors

Constructor and Description
AbstractXDIWriter(Properties parameters)

Method Summary

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.
protected void	init()
boolean	isWriteHtml()
boolean	isWriteImplied()
boolean	isWriteOrdered()
boolean	isWritePretty()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface xdi2.core.io.XDIWriter

write

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

parameters

protected Properties parameters

Constructor Detail

AbstractXDIWriter

public AbstractXDIWriter(Properties parameters)

Method Detail

init

protected void init()

write

public OutputStream write(Graph graph,
                          OutputStream stream)
                   throws IOException

Description copied from interface: XDIWriter

Writes an XDI graph to a byte stream.

Specified by:

write in interface XDIWriter

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

public OutputStream write(ContextNode contextNode,
                          OutputStream stream)
                   throws IOException

Description copied from interface: XDIWriter

Writes an XDI context node to a byte stream.

Specified by:

write in interface XDIWriter

stream - The byte stream to write to.

Returns:

The byte stream.

Throws:

IOException

write

public Writer write(ContextNode contextNode,
                    Writer writer)
             throws IOException

Description copied from interface: XDIWriter

Writes an XDI context node to a character stream.

Specified by:

write in interface XDIWriter

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

getFormat

public final String getFormat()

Description copied from interface: XDIWriter

Returns the format this XDIWriter can write, e.g.

• XDI/JSON
• XDI DISPLAY

Specified by:

getFormat in interface XDIWriter

Returns:

The format of this XDIWriter.

getFileExtension

public final String getFileExtension()

Description copied from interface: XDIWriter

Returns the file extension of this XDIWriter, e.g.

• .json
• .xdi

Specified by:

getFileExtension in interface XDIWriter

Returns:

The file extension of this XDIWriter.

getMimeType

public final MimeType getMimeType()

Description copied from interface: XDIWriter

Returns the mime type this XDIWriter can write, e.g.

• text/plain
• application/xdi+json

Specified by:

getMimeType in interface XDIWriter

Returns:

The mime type of this XDIWriter.

supportsFormat

public boolean supportsFormat(String format)

Description copied from interface: XDIWriter

Checks if a given format is supported.

Specified by:

supportsFormat in interface XDIWriter

Returns:

True, if supported.

supportsFileExtension

public boolean supportsFileExtension(String fileExtension)

Description copied from interface: XDIWriter

Checks if a given file extension is supported.

Specified by:

supportsFileExtension in interface XDIWriter

Returns:

True, if supported.

supportsMimeType

public boolean supportsMimeType(MimeType mimeType)

Description copied from interface: XDIWriter

Checks if a given mime type is supported.

Specified by:

supportsMimeType in interface XDIWriter

Returns:

True, if supported.

isWriteImplied

public boolean isWriteImplied()

isWriteOrdered

public boolean isWriteOrdered()

isWritePretty

public boolean isWritePretty()

isWriteHtml

public boolean isWriteHtml()