ezvcard.io.html

Class HCardPage

java.lang.Object

ezvcard.io.html.HCardPage

public class HCardPage
extends Object

Writes VCard objects to a templated HTML page (hCard format).

Example:

 VCard vcard1 = ...
 VCard vcard2 = ...
 
 HCardPage page = new HCardPage();
 page.add(vcard1);
 page.add(vcard2);
 
 File file = new File("hcard.html");
 page.write(file);
 

Author:

Michael Angstadt

See Also:

http://microformats.org/wiki/hcard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HCardPage.TemplateUtils Utility functions for the freemarker template.

Constructor Summary

Constructors

Constructor and Description
HCardPage() Creates a new hCard page that uses the default template.
HCardPage(freemarker.template.Template template) Creates a new hCard page using a custom template.

Method Summary

Modifier and Type	Method and Description
void	add(VCard vcard) Adds a vCard to the HTML page.
String	write() Writes the HTML document to a string.
void	write(OutputStream out) Writes the HTML document to an output stream.
void	write(Path file) Writes the HTML document to a file.
void	write(Writer writer) Writes the HTML document to a writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

HCardPage

public HCardPage()

Creates a new hCard page that uses the default template.

HCardPage

public HCardPage(freemarker.template.Template template)

Creates a new hCard page using a custom template. See the default template for an example.

Parameters:

template - the template to use

Method Detail

add

public void add(VCard vcard)

Adds a vCard to the HTML page.

Parameters:

vcard - the vCard to add

write

public String write()
             throws freemarker.template.TemplateException

Writes the HTML document to a string.

Returns:

the HTML document

Throws:

freemarker.template.TemplateException - if there's a problem processing the template

write

public void write(OutputStream out)
           throws IOException,
                  freemarker.template.TemplateException

Writes the HTML document to an output stream.

Parameters:

out - the output stream

Throws:

IOException - if there's a problem writing to the output stream

freemarker.template.TemplateException - if there's a problem processing the template

write

public void write(Path file)
           throws IOException,
                  freemarker.template.TemplateException

Writes the HTML document to a file.

Parameters:

file - the file

Throws:

IOException - if there's a problem writing to the file

freemarker.template.TemplateException - if there's a problem processing the template

write

public void write(Writer writer)
           throws IOException,
                  freemarker.template.TemplateException

Writes the HTML document to a writer.

Parameters:

writer - the writer

Throws:

IOException - if there's a problem writing to the writer

freemarker.template.TemplateException - if there's a problem processing the template