Ezvcard (ez-vcard 0.7.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ezvcard
Class Ezvcard

java.lang.Object
  ezvcard.Ezvcard

public class Ezvcard
extends Object
extends Object

Contains helper methods for parsing/writing vCards. The methods wrap the following classes:

	Reading	Writing
Plain text	`VCardReader`	`VCardWriter`
XML	`XCardReader`	`XCardDocument`
HTML	`HCardReader`	`HCardPage`

Author:: Michael Angstadt

Nested Class Summary
`static class`	`Ezvcard.ParserChainHtmlReader` Convenience chainer class for parsing HTML vCards.
`static class`	`Ezvcard.ParserChainHtmlString` Convenience chainer class for parsing HTML vCards.
`static class`	`Ezvcard.ParserChainTextReader` Convenience chainer class for parsing plain text vCards.
`static class`	`Ezvcard.ParserChainTextString` Convenience chainer class for parsing plain text vCards.
`static class`	`Ezvcard.ParserChainXmlDom` Convenience chainer class for parsing XML vCards.
`static class`	`Ezvcard.ParserChainXmlReader` Convenience chainer class for parsing XML vCards.
`static class`	`Ezvcard.ParserChainXmlString` Convenience chainer class for parsing XML vCards.
`static class`	`Ezvcard.WriterChainHtml` Convenience chainer class for writing HTML vCards (hCard).
`static class`	`Ezvcard.WriterChainTextMulti` Convenience chainer class for writing plain text vCards
`static class`	`Ezvcard.WriterChainTextSingle` Convenience chainer class for writing plain text vCards
`static class`	`Ezvcard.WriterChainXmlMulti` Convenience chainer class for writing XML vCards (xCard).
`static class`	`Ezvcard.WriterChainXmlSingle` Convenience chainer class for writing XML vCards (xCard).

Field Summary
`static String`	`URL` The project webpage.
`static String`	`VERSION` The version of the library.

Method Summary
`static Ezvcard.ParserChainTextReader`	`parse(File file)` Parses plain text vCards.
`static Ezvcard.ParserChainTextReader`	`parse(InputStream in)` Parses plain text vCards.
`static Ezvcard.ParserChainTextReader`	`parse(Reader reader)` Parses plain text vCards.
`static Ezvcard.ParserChainTextString`	`parse(String str)` Parses plain text vCards.
`static Ezvcard.ParserChainHtmlReader`	`parseHtml(File file)` Parses HTML-encoded vCards (hCard).
`static Ezvcard.ParserChainHtmlReader`	`parseHtml(InputStream in)` Parses HTML-encoded vCards (hCard).
`static Ezvcard.ParserChainHtmlReader`	`parseHtml(Reader reader)` Parses HTML-encoded vCards (hCard).
`static Ezvcard.ParserChainHtmlString`	`parseHtml(String html)` Parses HTML-encoded vCards (hCard).
`static Ezvcard.ParserChainHtmlReader`	`parseHtml(URL url)` Parses HTML-encoded vCards (hCard).
`static Ezvcard.ParserChainXmlDom`	`parseXml(Document document)` Parses XML-encoded vCards (xCard).
`static Ezvcard.ParserChainXmlReader`	`parseXml(File file)` Parses XML-encoded vCards (xCard).
`static Ezvcard.ParserChainXmlReader`	`parseXml(InputStream in)` Parses XML-encoded vCards (xCard).
`static Ezvcard.ParserChainXmlReader`	`parseXml(Reader reader)` Parses XML-encoded vCards (xCard).
`static Ezvcard.ParserChainXmlString`	`parseXml(String xml)` Parses XML-encoded vCards (xCard).
`static Ezvcard.WriterChainTextMulti`	`write(Collection<VCard> vcards)` Marshals multiple vCards to their traditional, plain-text representation.
`static Ezvcard.WriterChainTextMulti`	`write(VCard... vcards)` Marshals multiple vCards to their traditional, plain-text representation.
`static Ezvcard.WriterChainTextSingle`	`write(VCard vcard)` Marshals a vCard to its traditional, plain-text representation.
`static Ezvcard.WriterChainHtml`	`writeHtml(Collection<VCard> vcards)` Marshals one or more vCards their HTML representation (hCard).
`static Ezvcard.WriterChainHtml`	`writeHtml(VCard... vcards)` Marshals one or more vCards their HTML representation (hCard).
`static Ezvcard.WriterChainXmlMulti`	`writeXml(Collection<VCard> vcards)` Marshals multiple vCards to their XML representation (xCard).
`static Ezvcard.WriterChainXmlMulti`	`writeXml(VCard... vcards)` Marshals multiple vCards to their XML representation (xCard).
`static Ezvcard.WriterChainXmlSingle`	`writeXml(VCard vcard)` Marshals a vCard to its XML representation (xCard).

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

VERSION

public static final String VERSION

The version of the library.

URL

public static final String URL

The project webpage.

Method Detail

parse

public static Ezvcard.ParserChainTextString parse(String str)

Parses plain text vCards.

Use VCardReader for more control over the parsing.

Parameters:: str - the vCard string
Returns:: chainer object for completing the parse operation
See Also:: VCardReader, vCard 2.1, RFC 2426 (3.0), RFC 6350 (4.0)

parse

public static Ezvcard.ParserChainTextReader parse(File file)
                                           throws FileNotFoundException

Parses plain text vCards.

Use VCardReader for more control over the parsing.

Parameters:: file - the vCard file
Returns:: chainer object for completing the parse operation
Throws:: FileNotFoundException - if the file does not exist or cannot be accessed
See Also:: VCardReader, vCard 2.1, RFC 2426 (3.0), RFC 6350 (4.0)

parse

public static Ezvcard.ParserChainTextReader parse(InputStream in)

Parses plain text vCards.

Use VCardReader for more control over the parsing.

Parameters:: in - the input stream
Returns:: chainer object for completing the parse operation
See Also:: VCardReader, vCard 2.1, RFC 2426 (3.0), RFC 6350 (4.0)

parse

public static Ezvcard.ParserChainTextReader parse(Reader reader)

Parses plain text vCards.

Use VCardReader for more control over the parsing.

Parameters:: reader - the reader
Returns:: chainer object for completing the parse operation
See Also:: VCardReader, vCard 2.1, RFC 2426 (3.0), RFC 6350 (4.0)