org.cloudbees.literate.api.v1

Class ProjectModelFormatter

java.lang.Object

org.cloudbees.literate.api.v1.ProjectModelFormatter

Direct Known Subclasses:

MarkdownProjectModelFormatter

public abstract class ProjectModelFormatter
extends Object

A formatter of ProjectModel instances.

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field and Description
static String	MARKDOWN The Markdown mime type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProjectModelFormatter(String mimeType) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	format(ProjectModel model) Formats the model as a string.
static ProjectModelFormatter	getInstance(ClassLoader classLoader, String mimeType) Gets an instance from the specified classloader for the specified mime type.
static ProjectModelFormatter	getInstance(String mimeType) Gets an instance from the current thread's context classloader for the specified mime type.

Methods inherited from class java.lang.Object

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

Field Detail

MARKDOWN

public static final String MARKDOWN

The Markdown mime type. A ProjectModelFormatter supporting this mime type must be available.

See Also:

Constant Field Values

Constructor Detail

ProjectModelFormatter

protected ProjectModelFormatter(String mimeType)

Constructor.

Parameters:

mimeType - the mime type.

Method Detail

format

public abstract String format(ProjectModel model)

Formats the model as a string.

Parameters:

model - the model.

Returns:

the string formatted model.

getInstance

@CheckForNull
public static ProjectModelFormatter getInstance(@NonNull
                                             String mimeType)

Gets an instance from the current thread's context classloader for the specified mime type.

Parameters:

mimeType - the mime type.

Returns:

the instance or null if no instance available for the specified mime type.

getInstance

@CheckForNull
public static ProjectModelFormatter getInstance(@NonNull
                                             ClassLoader classLoader,
                                             @NonNull
                                             String mimeType)

Gets an instance from the specified classloader for the specified mime type.

Parameters:

classLoader - the classloader.

mimeType - the mime type.

Returns:

the instance or null if no instance available for the specified mime type.