Package dev.enola.common.io.resource

Class MarkdownResource

java.lang.Object

dev.enola.common.io.resource.BaseResource

dev.enola.common.io.resource.DelegatingReadableResource

dev.enola.common.io.resource.ReadableButNotWritableDelegatingResource

dev.enola.common.io.resource.DelegatingMultipartResource

dev.enola.common.io.resource.RegexMultipartResource

dev.enola.common.io.resource.MarkdownResource

All Implemented Interfaces:

AbstractResource, MultipartResource, ReadableButNotWritableResource, ReadableResource, Resource, WritableResource

public class MarkdownResource
extends RegexMultipartResource

MarkdownResource is a MultipartResource which separates "Front Matter" (as FRONT part, typically YAML structured data) and Markdown content (as MARKDOWN) from the base resource.

The "front matter" is anything between 2 "---" lines at the very start of the file (if present, it's optional), and the "body" (in Markdown text) is everything that follows. Any HTML comment before the front-matter is stripped (this is useful, e.g. to ignore license headers).

This is a very common quasi de-facto standard format used by many Markdown tools. It may (TBC) originally have been introduced by Jekyll.

Nested Class Summary

Nested classes/interfaces inherited from class dev.enola.common.io.resource.RegexMultipartResource

RegexMultipartResource.PartsDef

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIRST_COMMENT
static final String	FRONT
static final String	MARKDOWN

Fields inherited from class dev.enola.common.io.resource.DelegatingReadableResource

delegate

Fields inherited from class dev.enola.common.io.resource.BaseResource

mediaType, uri

Fields inherited from interface dev.enola.common.io.resource.MultipartResource

MEDIA_TYPE

Fields inherited from interface dev.enola.common.io.resource.ReadableResource

LOGGER

Constructor Summary

Constructors

Constructor	Description
MarkdownResource(ReadableResource baseResource)
MarkdownResource(ReadableResource baseResource, MediaType bodyMediaType)

Method Summary

Modifier and Type	Method	Description
Resource	frontMatter()
Resource	markdown()

Methods inherited from class dev.enola.common.io.resource.DelegatingMultipartResource

part, parts

Methods inherited from class dev.enola.common.io.resource.DelegatingReadableResource

byteSource, charSource

Methods inherited from class dev.enola.common.io.resource.BaseResource

mediaType, toString, uri

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.enola.common.io.resource.AbstractResource

mediaType, uri

Methods inherited from interface dev.enola.common.io.resource.MultipartResource

mediaType, uri

Methods inherited from interface dev.enola.common.io.resource.ReadableButNotWritableResource

byteSink

Methods inherited from interface dev.enola.common.io.resource.ReadableResource

byteSource, changeToken, charSource, isDifferent, isDifferent

Methods inherited from interface dev.enola.common.io.resource.WritableResource

charSink

Field Details

FIRST_COMMENT

public static final String FIRST_COMMENT

See Also:

• Constant Field Values

FRONT

public static final String FRONT

See Also:

• Constant Field Values

MARKDOWN

public static final String MARKDOWN

See Also:

• Constant Field Values

Constructor Details

MarkdownResource

public MarkdownResource(ReadableResource baseResource)
                 throws IOException

Throws:

IOException

MarkdownResource

public MarkdownResource(ReadableResource baseResource,
 MediaType bodyMediaType)
                 throws IOException

Throws:

IOException

Method Details

frontMatter

public Resource frontMatter()

markdown

public Resource markdown()