ezvcard.property

Class Xml

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.Xml

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

@SupportedVersions(value=V4_0)
public class Xml
extends VCardProperty
implements HasAltId

Contains an XML element that was not recognized when parsing an xCard (XML-formatted vCard).

Code sample

 VCard vcard = new VCard();
 
 Xml xml = new Xml("<b>Some xml</b>");
 vcard.addXml(xml);
 

Property name: XML

Supported versions: 4.0

Author:

Michael Angstadt

See Also:

RFC 6350 p.27

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Xml(Document document) Creates an XML property.
Xml(Element element) Creates an XML property.
Xml(String xml) Creates an XML property.
Xml(Xml original) Copy constructor.

Method Summary

Modifier and Type	Method and Description
protected void	_validate(List<ValidationWarning> warnings, VCardVersion version, VCard vcard) Checks the property for data consistency problems or deviations from the spec.
Xml	copy() Creates a copy of this property object.
boolean	equals(Object obj)
String	getAltId() Gets the property's ALTID parameter.
Document	getValue() Gets the value of this property.
int	hashCode()
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setValue(Document value) Sets the value of this property.
protected Map<String,Object>	toStringValues() Gets string representations of the class's fields for the VCardProperty.toString() method.

Methods inherited from class ezvcard.property.VCardProperty

addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, isSupportedBy, removeParameter, setGroup, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Xml

public Xml(String xml)
    throws SAXException

Creates an XML property.

Parameters:

xml - the XML to use as the property's value

Throws:

SAXException - if the XML cannot be parsed

Xml

public Xml(Element element)

Creates an XML property.

Parameters:

element - the XML element to use as the property's value (the element is imported into an empty Document object)

Xml

public Xml(Document document)

Creates an XML property.

Parameters:

document - the XML document to use as the property's value

Xml

public Xml(Xml original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getValue

public Document getValue()

Gets the value of this property.

Returns:

the value or null if not set

setValue

public void setValue(Document value)

Sets the value of this property.

Parameters:

value - the value

getAltId

public String getAltId()

Description copied from interface: HasAltId

Gets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

getAltId in interface HasAltId

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardParameters.getAltId()

setAltId

public void setAltId(String altId)

Description copied from interface: HasAltId

Sets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

setAltId in interface HasAltId

Parameters:

altId - the ALTID or null to remove

See Also:

VCardParameters.setAltId(java.lang.String)

_validate

protected void _validate(List<ValidationWarning> warnings,
                         VCardVersion version,
                         VCard vcard)

Description copied from class: VCardProperty

Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.

Overrides:

_validate in class VCardProperty

Parameters:

warnings - the list to add the warnings to

version - the version to check the property against

vcard - the vCard this property belongs to

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: VCardProperty

Gets string representations of the class's fields for the VCardProperty.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class VCardProperty

Returns:

the values of the class's fields (key = field name, value = field value)

copy

public Xml copy()

Description copied from class: VCardProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the VCardProperty.VCardProperty(VCardProperty) super constructor to ensure that the group name and parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the VCard class's copy constructor).

Overrides:

copy in class VCardProperty

Returns:

the copy

hashCode

public int hashCode()

Overrides:

hashCode in class VCardProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class VCardProperty