Package org.apache.juneau.marshall.markdown

Class MarkdownDocParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.ReaderParser

org.apache.juneau.marshall.markdown.MarkdownParser

org.apache.juneau.marshall.markdown.MarkdownDocParser

All Implemented Interfaces:

MarkdownMetaProvider, RecordReadable

public class MarkdownDocParser
extends MarkdownParser

Parses Markdown document-mode output (headings + tables) back to POJOs.

Media types

Handles Content-Type types: text/markdown, text/x-markdown

Description

Extends MarkdownParser to parse Markdown documents produced by MarkdownDocSerializer. Heading sections are mapped back to nested bean properties based on heading text matching property names.

Example:

// Parse a Markdown document back to a bean String md = "# Person\n\n| Property | Value |\n|---|---|\n| name | Alice |\n\n## address\n\n| Property | Value |\n|---|---|\n| city | Boston |"; Person p = MarkdownDocParser.DEFAULT.read(md, Person.class);

// Round-trip example String md = MarkdownDocSerializer.DEFAULT.write(myBean); MyBean parsed = MarkdownDocParser.DEFAULT.read(md, MyBean.class);

Limitations:

• Heading text must match bean property names exactly (case-sensitive).
• Heading levels must be consistent with serializer output; manually edited heading levels may not parse correctly.
• A heading followed by a bulleted list is treated as a List<String> property.
• A heading followed by a multi-column table is treated as a List<Bean> property.
• The top-level heading (title) is ignored; only sub-headings map to properties.
• This class is thread safe and reusable.

See Also:

• Markdown

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkdownDocParser.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.markdown.MarkdownParser

MarkdownParser.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final MarkdownDocParser	DEFAULT	Default parser, all default settings.

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
MarkdownDocParser(MarkdownDocParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
MarkdownDocParser.Builder	copy()	Creates a builder from this context object.
static MarkdownDocParser.Builder	create()	Creates a new builder for this object.
MarkdownDocParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
MarkdownDocParserSession	getSession()	Returns a session to use for this context.

Methods inherited from class org.apache.juneau.marshall.markdown.MarkdownParser

getMarkdownBeanPropertyMeta, getMarkdownClassMeta, getNullValue, isRecordStreaming, readRecords

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParser

getStreamCharset, isReaderParser, properties

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final MarkdownDocParser DEFAULT

Default parser, all default settings.

Constructor Details

MarkdownDocParser

public MarkdownDocParser(MarkdownDocParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MarkdownDocParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public MarkdownDocParser.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class MarkdownParser

Returns:

A new Builder object.

createSession

public MarkdownDocParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class MarkdownParser

Returns:

A new session builder.

getSession

public MarkdownDocParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class MarkdownParser

Returns:

A new session object.