ezvcard.io.html

Class HCardParser

java.lang.Object

ezvcard.io.StreamReader

ezvcard.io.html.HCardParser

All Implemented Interfaces:

Closeable, AutoCloseable

public class HCardParser
extends StreamReader

Parses VCard objects from an HTML page (hCard format).

Example:

 URL url = new URL("http://example.com");
 HCardParser parser = new HCardParser(url);
 List<VCard> vcards = parser.parseAll();
 

Author:

Michael Angstadt

See Also:

http://microformats.org/ wiki/hcard

Field Summary

Fields inherited from class ezvcard.io.StreamReader

context, index, warnings

Constructor Summary

Constructors

Constructor and Description
HCardParser(org.jsoup.nodes.Document document) Creates an hCard document.
HCardParser(org.jsoup.nodes.Document document, String pageUrl) Creates an hCard document.
HCardParser(InputStream in) Creates an hCard document.
HCardParser(InputStream in, String pageUrl) Creates an hCard document.
HCardParser(Path file) Creates an hCard document.
HCardParser(Path file, String pageUrl) Creates an hCard document.
HCardParser(Reader reader) Creates an hCard document.
HCardParser(Reader reader, String pageUrl) Creates an hCard document.
HCardParser(String html) Creates an hCard document.
HCardParser(String html, String pageUrl) Creates an hCard document.
HCardParser(URL url) Creates an hCard document.

Method Summary

Modifier and Type	Method and Description
protected VCard	_readNext() Reads the next vCard from the data stream.
void	close()
VCard	readNext() Reads the next vCard from the data stream.

Methods inherited from class ezvcard.io.StreamReader

assignLabels, getScribeIndex, getWarnings, readAll, registerScribe, setScribeIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

HCardParser

public HCardParser(URL url)
            throws IOException

Creates an hCard document.

Parameters:

url - the URL of the webpage

Throws:

IOException - if there's a problem loading the webpage

HCardParser

public HCardParser(InputStream in)
            throws IOException

Creates an hCard document.

Parameters:

in - the input stream to the HTML page

Throws:

IOException - if there's a problem reading the HTML page

HCardParser

public HCardParser(InputStream in,
                   String pageUrl)
            throws IOException

Creates an hCard document.

Parameters:

in - the input stream to the HTML page

pageUrl - the original URL of the HTML page (used to resolve relative links)

Throws:

IOException - if there's a problem reading the HTML page

HCardParser

public HCardParser(Path file)
            throws IOException

Creates an hCard document.

Parameters:

file - the HTML file

Throws:

IOException - if there's a problem reading the HTML file

HCardParser

public HCardParser(Path file,
                   String pageUrl)
            throws IOException

Creates an hCard document.

Parameters:

file - the HTML file

pageUrl - the original URL of the HTML page (used to resolve relative links)

Throws:

IOException - if there's a problem reading the HTML file

HCardParser

public HCardParser(Reader reader)
            throws IOException

Creates an hCard document.

Parameters:

reader - the input stream to the HTML page

Throws:

IOException - if there's a problem reading the HTML page

HCardParser

public HCardParser(Reader reader,
                   String pageUrl)
            throws IOException

Creates an hCard document.

Parameters:

reader - the input stream to the HTML page

pageUrl - the original URL of the HTML page (used to resolve relative links)

Throws:

IOException - if there's a problem reading the HTML page

HCardParser

public HCardParser(String html)

Creates an hCard document.

Parameters:

html - the HTML page

HCardParser

public HCardParser(String html,
                   String pageUrl)

Creates an hCard document.

Parameters:

html - the HTML page

pageUrl - the original URL of the HTML page (used to resolve relative links)

HCardParser

public HCardParser(org.jsoup.nodes.Document document)

Creates an hCard document.

Parameters:

document - the HTML page

HCardParser

public HCardParser(org.jsoup.nodes.Document document,
                   String pageUrl)

Creates an hCard document.

Parameters:

document - the HTML page

pageUrl - the original URL of the HTML page (used to resolve relative links)

Method Detail

readNext

public VCard readNext()

Description copied from class: StreamReader

Reads the next vCard from the data stream.

Overrides:

readNext in class StreamReader

Returns:

the next vCard or null if there are no more

_readNext

protected VCard _readNext()

Description copied from class: StreamReader

Reads the next vCard from the data stream.

Specified by:

_readNext in class StreamReader

Returns:

the next vCard or null if there are no more

close

public void close()