xdi2.core.io

Class XDIWriterRegistry

java.lang.Object

xdi2.core.io.XDIWriterRegistry

public final class XDIWriterRegistry
extends Object

Provides an appropriate XDIWriter for a given type.

Author:

markus

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HTML
static String	DEFAULT_IMPLIED
static String	DEFAULT_ORDERED
static String	DEFAULT_PRETTY
static String	PARAMETER_HTML
static String	PARAMETER_IMPLIED
static String	PARAMETER_ORDERED
static String	PARAMETER_PRETTY
static Properties	PROPERTIES_HTML
static Properties	PROPERTIES_IMPLIED
static Properties	PROPERTIES_ORDERED
static Properties	PROPERTIES_PRETTY

Method Summary

Modifier and Type	Method and Description
static void	addWriter(Class<? extends XDIWriter> writerClass)
static XDIWriter	forFileExtension(String fileExtension, Properties parameters) Returns an XDIWriter for the specified file extension, e.g.
static XDIWriter	forFormat(String format, Properties parameters) Returns an XDIWriter for the specified format, e.g.
static XDIWriter	forMimeType(MimeType mimeType) Returns an XDIWriter for the specified mime type, e.g.
static XDIWriter	getDefault() Returns an XDIWriter for the default format.
static String[]	getFileExtensions() Returns all file extensions for which XDIWriter implementations exist.
static String[]	getFormats() Returns all formats for which XDIWriter implementations exist.
static MimeType[]	getMimeTypes() Returns all mime types for which XDIWriter implementations exist.
static boolean	supportsFileExtension(MimeType fileExtension) Checks if we have an XDIWriter that supports this file extension.
static boolean	supportsFormat(String format) Checks if we have an XDIWriter that supports this format.
static boolean	supportsMimeType(MimeType mimeType) Checks if we have an XDIWriter that supports this MIME type.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_IMPLIED

public static final String PARAMETER_IMPLIED

See Also:

Constant Field Values

PARAMETER_ORDERED

public static final String PARAMETER_ORDERED

See Also:

Constant Field Values

PARAMETER_PRETTY

public static final String PARAMETER_PRETTY

See Also:

Constant Field Values

PARAMETER_HTML

public static final String PARAMETER_HTML

See Also:

Constant Field Values

DEFAULT_IMPLIED

public static final String DEFAULT_IMPLIED

See Also:

Constant Field Values

DEFAULT_ORDERED

public static final String DEFAULT_ORDERED

See Also:

Constant Field Values

DEFAULT_PRETTY

public static final String DEFAULT_PRETTY

See Also:

Constant Field Values

DEFAULT_HTML

public static final String DEFAULT_HTML

See Also:

Constant Field Values

PROPERTIES_IMPLIED

public static final Properties PROPERTIES_IMPLIED

PROPERTIES_ORDERED

public static final Properties PROPERTIES_ORDERED

PROPERTIES_PRETTY

public static final Properties PROPERTIES_PRETTY

PROPERTIES_HTML

public static final Properties PROPERTIES_HTML

Method Detail

addWriter

public static void addWriter(Class<? extends XDIWriter> writerClass)

forFormat

public static XDIWriter forFormat(String format,
                                  Properties parameters)

Returns an XDIWriter for the specified format, e.g.

• XDI/JSON
• XDI DISPLAY

Parameters:

format - The desired format.

Returns:

An XDIWriter, or null if no appropriate implementation could be found.

forFileExtension

public static XDIWriter forFileExtension(String fileExtension,
                                         Properties parameters)

Returns an XDIWriter for the specified file extension, e.g.

• .json
• .xdi

Parameters:

fileExtension - The desired file extension.

Returns:

An XDIWriter, or null if no appropriate implementation could be found.

forMimeType

public static XDIWriter forMimeType(MimeType mimeType)

Returns an XDIWriter for the specified mime type, e.g.

• application/xdi+json
• text/xdi

Parameters:

mimeType - The desired mime type.

Returns:

An XDIWriter, or null if no appropriate implementation could be found.

getDefault

public static XDIWriter getDefault()

Returns an XDIWriter for the default format.

Returns:

An XDIWriter.

getFormats

public static String[] getFormats()

Returns all formats for which XDIWriter implementations exist.

Returns:

A string array of formats.

getFileExtensions

public static String[] getFileExtensions()

Returns all file extensions for which XDIWriter implementations exist.

Returns:

A string array of file extensions.

getMimeTypes

public static MimeType[] getMimeTypes()

Returns all mime types for which XDIWriter implementations exist.

Returns:

A string array of mime types.

supportsFormat

public static boolean supportsFormat(String format)

Checks if we have an XDIWriter that supports this format.

Parameters:

format - The desired format.

Returns:

True, if supported.

supportsFileExtension

public static boolean supportsFileExtension(MimeType fileExtension)

Checks if we have an XDIWriter that supports this file extension.

Parameters:

fileExtension - The desired file extension.

Returns:

True, if supported.

supportsMimeType

public static boolean supportsMimeType(MimeType mimeType)

Checks if we have an XDIWriter that supports this MIME type.

Parameters:

mimeType - The desired mime type.

Returns:

True, if supported.