ezvcard.io.chain

Class ChainingHtmlWriter

java.lang.Object

ezvcard.io.chain.ChainingHtmlWriter

public class ChainingHtmlWriter
extends Object

Chainer class for writing hCards (HTML-encoded vCards).

Author:

Michael Angstadt

See Also:

Ezvcard.writeHtml(Collection), Ezvcard.writeHtml(VCard...)

Constructor Summary

Constructors

Constructor and Description
ChainingHtmlWriter(Collection<VCard> vcards)

Method Summary

Modifier and Type	Method and Description
String	go() Writes the hCards to a string.
void	go(OutputStream out) Writes the hCards to an output stream.
void	go(Path file) Writes the hCards to a file.
void	go(Writer writer) Writes the hCards to a writer.
ChainingHtmlWriter	template(freemarker.template.Template template) Sets the freemarker template to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainingHtmlWriter

public ChainingHtmlWriter(Collection<VCard> vcards)

Parameters:

vcards - the vCards to write

Method Detail

template

public ChainingHtmlWriter template(freemarker.template.Template template)

Sets the freemarker template to use.

Parameters:

template - the template (defaults to an embedded template)

Returns:

this

go

public String go()
          throws freemarker.template.TemplateException

Writes the hCards to a string.

Returns:

the HTML page

Throws:

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

go

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

Writes the hCards to an output stream.

Parameters:

out - the output stream to write to

Throws:

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

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

go

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

Writes the hCards to a file.

Parameters:

file - the file to write to

Throws:

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

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

go

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

Writes the hCards to a writer.

Parameters:

writer - the writer to write to

Throws:

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

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