com.kylewm.mf2j

Class Mf2Parser

java.lang.Object

com.kylewm.mf2j.Mf2Parser

public class Mf2Parser
extends Object

Parse a Microformats2 formatted HTML document.

Author:

kmahan

Constructor Summary

Constructors

Constructor and Description
Mf2Parser() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
JsonDict	parse(org.jsoup.nodes.Document doc, URI baseUri) Parse an existing document for microformats2.
JsonDict	parse(String html, URI baseUri) Parse an existing document for microformats2.
JsonDict	parse(URI resource) Fetch a remote resource and parse it for microformats2.
Mf2Parser	setIncludeAlternates(boolean includeAlts) If true, include the "alternates" key in the parsed output.
Mf2Parser	setIncludeRelUrls(boolean includeRelUrls) If true, include the experimental "rel-urls" hash in the parsed output.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mf2Parser

public Mf2Parser()

Constructor

Method Detail

setIncludeAlternates

public Mf2Parser setIncludeAlternates(boolean includeAlts)

If true, include the "alternates" key in the parsed output.

Parameters:

includeAlts -

Returns:

this, for method chaining

setIncludeRelUrls

public Mf2Parser setIncludeRelUrls(boolean includeRelUrls)

If true, include the experimental "rel-urls" hash in the parsed output.

Parameters:

includeRelUrls -

Returns:

this, for method chaining

parse

public JsonDict parse(URI resource)
               throws IOException

Fetch a remote resource and parse it for microformats2.

Parameters:

resource - the URI of the resource to fetch.

Returns:

a well-defined JSON structure containing the parsed microformats2 data.

Throws:

IOException

parse

public JsonDict parse(String html,
             URI baseUri)

Parse an existing document for microformats2.

Parameters:

html - the contents of the document to parse

baseUri - the URI where the document exists, used for normalization

Returns:

a well-defined JSON structure containing the parsed microformats2 data.

parse

public JsonDict parse(org.jsoup.nodes.Document doc,
             URI baseUri)

Parse an existing document for microformats2.

Parameters:

doc - the Jsoup document to parse

baseUri - the URI where the document exists, used for normalization

Returns:

a well-defined JSON structure containing the parsed microformats2 data.