ezvcard.util
Class XCardElement

java.lang.Object
  ezvcard.util.XCardElement

public class XCardElement
extends Object

Wraps xCard functionality around an XML Element.

Author:

Michael Angstadt

Constructor Summary

XCardElement(Element element)
Wraps an existing XML element.

XCardElement(Element element, VCardVersion version)
Wraps an existing XML element.

XCardElement(String propertyName)
Creates a new XML element under its own XML document.

XCardElement(String propertyName, VCardVersion version)
Creates a new XML element under its own XML document.

Method Summary

List<Element>	append(String name, Collection<String> values) Adds multiple child elements, each with the same name.
Element	append(String name, String value) Adds a child element.
String	dateAndOrTime() Gets the value of the first <date-and-or-time> child element.
Element	dateAndOrTime(String dateAndOrTime) Adds a <date-and-or-time> child element.
Document	document() Gets the owner document.
Element	element() Gets the wrapped XML element.
String	get(String... names) Gets the value of the first child element with one of the given names.
List<String>	getAll(String localName) Gets the value of all non-empty child elements that have the given name.
String	text() Gets the value of the first <text> child element.
Element	text(String text) Adds a <text> child element.
String	timestamp() Gets the value of the first <timestamp> child element.
Element	timestamp(String timestamp) Adds a <timestamp> child element.
String	uri() Gets the value of the first <uri> child element.
Element	uri(String uri) Adds a <uri> child element.
VCardVersion	version() Gets the vCard version.

Methods inherited from class java.lang.Object

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

Constructor Detail

XCardElement

public XCardElement(String propertyName)

Creates a new XML element under its own XML document.

Parameters:

propertyName - the property name (e.g. "adr")

XCardElement

public XCardElement(String propertyName,
                    VCardVersion version)

Creates a new XML element under its own XML document.

Parameters:

propertyName - the property name (e.g. "adr")

version - the vCard version

XCardElement

public XCardElement(Element element)

Wraps an existing XML element.

Parameters:

element - the XML element

XCardElement

public XCardElement(Element element,
                    VCardVersion version)

Wraps an existing XML element.

Parameters:

element - the XML element

version - the vCard version

Method Detail

text

public String text()

Gets the value of the first <text> child element.

Returns:

the text value or null if not found

uri

public String uri()

Gets the value of the first <uri> child element.

Returns:

the URI or null if not found

dateAndOrTime

public String dateAndOrTime()

Gets the value of the first <date-and-or-time> child element.

Returns:

the value or null if not found

timestamp

public String timestamp()

Gets the value of the first <timestamp> child element.

Returns:

the timestamp or null if not found

get

public String get(String... names)

Gets the value of the first child element with one of the given names.

Parameters:

names - the possible names of the element

Returns:

the element's text or null if not found

getAll

public List<String> getAll(String localName)

Gets the value of all non-empty child elements that have the given name.

Parameters:

localName - the element name

Returns:

the values of the child elements

text

public Element text(String text)

Adds a <text> child element.

Parameters:

text - the text

Returns:

the created element

uri

public Element uri(String uri)

Adds a <uri> child element.

Parameters:

uri - the URI

Returns:

the created element

dateAndOrTime

public Element dateAndOrTime(String dateAndOrTime)

Adds a <date-and-or-time> child element.

Parameters:

dateAndOrTime - the date/time

Returns:

the created element

timestamp

public Element timestamp(String timestamp)

Adds a <timestamp> child element.

Parameters:

timestamp - the timestamp

Returns:

the created element

append

public Element append(String name,
                      String value)

Adds a child element.

Parameters:

name - the name of the child element

value - the value of the child element.

Returns:

the created element

append

public List<Element> append(String name,
                            Collection<String> values)

Adds multiple child elements, each with the same name.

Parameters:

name - the name for all the child elements

values - the values of each child element

Returns:

the created elements

document

public Document document()

Gets the owner document.

Returns:

the owner document

element

public Element element()

Gets the wrapped XML element.

Returns:

the wrapped XML element

version

public VCardVersion version()

Gets the vCard version.

Returns:

the vCard version