Package org.apache.juneau.marshall.markdown

Class MarkdownParser

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

All Implemented Interfaces:

MarkdownMetaProvider, RecordReadable

Direct Known Subclasses:

MarkdownDocParser

public class MarkdownParser
extends ReaderParser
implements MarkdownMetaProvider, RecordReadable

Parses Markdown fragment-mode output (tables and lists) back to POJOs.

Media types

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

Description

Parses Markdown tables and bulleted lists produced by MarkdownSerializer back into Java objects. The following mappings apply:

• 2-column key/value tables are parsed as beans or Maps.
• Multi-column tables are parsed as Lists of beans or Maps.
• Bulleted lists are parsed as Lists.
• Table cells containing backtick-wrapped JSON5 values are parsed via Json5Parser.

Example:

// Parse a Markdown table to a bean String md = "| Property | Value |\n|---|---|\n| name | Alice |\n| age | 30 |"; Person p = MarkdownParser.DEFAULT.read(md, Person.class);

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

Limitations:

• Multi-line string values cannot round-trip; newlines in cells are literal <br> text.
• The configured null value string (default: *null*) is interpreted as null, not as the literal string.
• Without a target type, table cell values are auto-detected as Integer, Long, Double, Boolean, or String.
• Type ambiguity: without a target type, tables return Map<String,Object> (key/value) or List<Map> (multi-column).
• This class is thread safe and reusable.

See Also:

• Markdown

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkdownParser.Builder<SELF extends MarkdownParser.Builder<SELF>>	Builder class.
static final class	MarkdownParser.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() / copy() path.

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

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final MarkdownParser	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
MarkdownParser(MarkdownParser.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
MarkdownParser.Builder<?>	copy()	Creates a builder from this context object.
static MarkdownParser.Builder<?>	create()	Creates a new builder for this object.
MarkdownParserSession.Builder<?>	createSession()	Create a session builder based on the properties defined on this context.
MarkdownBeanPropertyMeta	getMarkdownBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
MarkdownClassMeta	getMarkdownClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
String	getNullValue()	Returns the string that is interpreted as null when parsing.
MarkdownParserSession	getSession()	Returns a session to use for this context.
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordReader	readRecords(Object input)	Convenience delegator that opens a RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

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 MarkdownParser DEFAULT

Default parser, all default settings.

Constructor Details

MarkdownParser

public MarkdownParser(MarkdownParser.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MarkdownParser.Builder<?> create()

Creates a new builder for this object.

Returns:

A new builder.

getNullValue

public String getNullValue()

Returns the string that is interpreted as null when parsing.

Returns:

The null marker.

copy

public MarkdownParser.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 Parser

Returns:

A new Builder object.

createSession

public MarkdownParserSession.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 ReaderParser

Returns:

A new session builder.

getMarkdownBeanPropertyMeta

public MarkdownBeanPropertyMeta getMarkdownBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: MarkdownMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getMarkdownBeanPropertyMeta in interface MarkdownMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getMarkdownClassMeta

public MarkdownClassMeta getMarkdownClassMeta(ClassMeta<?> cm)

Description copied from interface: MarkdownMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getMarkdownClassMeta in interface MarkdownMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getSession

public MarkdownParserSession 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 ReaderParser

Returns:

A new session object.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Convenience delegator that opens a RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

The real implementation lives on MarkdownParserSession.readRecords(Object). Callers that need request-derived configuration (locale, timezone, schema, swaps) should call createSession() and invoke MarkdownParserSession.readRecords(Object) on the built session instead.

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred opening the underlying input.

isRecordStreaming

public boolean isRecordStreaming()

Description copied from interface: RecordReadable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

true if RecordReadable.readRecords(Object) returns an O(1)-memory streaming cursor; false for buffered (whole-value) formats backed by RecordAdapter.