org.opencrx.application.uses.ezvcard.io.scribe

Class ScribeIndex

java.lang.Object

org.opencrx.application.uses.ezvcard.io.scribe.ScribeIndex

public class ScribeIndex
extends Object

Manages a collection of property scribes (marshallers) to use when reading or writing a vCard. The same instance of this object can be re-used across multiple vCard reader/writer objects. This is useful if you have custom scribe classes defined, as it allows you to only define them once instead of each time a vCard reader/writer object is created.

Example:

 //init the index
 ScribeIndex index = new ScribeIndex();
 index.register(new CustomPropertyScribe());
 index.register(new AnotherCustomPropertyScribe());
 
 //inject the ScribeIndex into a plain-text vCard reader class and read the vCard data stream
 VCardReader vcardReader = new VCardReader(...);
 vcardReader.setScribeIndex(index);
 List<VCard> vcards = new ArrayList<VCard>();
 VCard vcard;
 while ((vcards = vcardReader.readNext()) != null){
   vcards.add(vcard);
 }
 vcardReader.close();
 
 //inject the same ScribeIndex instance into a jCard writer and write the vCards
 JCardWriter jcardWriter = new JCardWriter(...);
 jcardWriter.setScribeIndex(index);
 for (VCard vcard : vcards){
   jcardWriter.write(vcard);
 }
 jcardWriter.close();
 

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
ScribeIndex()

Method Summary

Modifier and Type	Method and Description
VCardPropertyScribe<? extends VCardProperty>	getPropertyScribe(Class<? extends VCardProperty> clazz) Gets a property scribe by class.
VCardPropertyScribe<? extends VCardProperty>	getPropertyScribe(QName qname) Gets a property scribe by XML local name and namespace.
VCardPropertyScribe<? extends VCardProperty>	getPropertyScribe(String propertyName) Gets a property scribe by name.
VCardPropertyScribe<? extends VCardProperty>	getPropertyScribe(VCardProperty property) Gets the appropriate property scribe for a given property instance.
boolean	hasPropertyScribe(VCardProperty property) Determines if a scribe exists for a given property instance.
void	register(VCardPropertyScribe<? extends VCardProperty> scribe) Registers a property scribe.
void	unregister(VCardPropertyScribe<? extends VCardProperty> scribe) Unregisters a property scribe.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScribeIndex

public ScribeIndex()

Method Detail

getPropertyScribe

public VCardPropertyScribe<? extends VCardProperty> getPropertyScribe(String propertyName)

Gets a property scribe by name.

Parameters:

propertyName - the property name (case-insensitive, e.g. "FN")

Returns:

the property scribe or null if not found

hasPropertyScribe

public boolean hasPropertyScribe(VCardProperty property)

Determines if a scribe exists for a given property instance.

Parameters:

property - the property

Returns:

true if a scribe exists, false if not

getPropertyScribe

public VCardPropertyScribe<? extends VCardProperty> getPropertyScribe(Class<? extends VCardProperty> clazz)

Gets a property scribe by class.

Parameters:

clazz - the property class

Returns:

the property scribe or null if not found

getPropertyScribe

public VCardPropertyScribe<? extends VCardProperty> getPropertyScribe(VCardProperty property)

Gets the appropriate property scribe for a given property instance.

Parameters:

property - the property instance

Returns:

the property scribe or null if not found

getPropertyScribe

public VCardPropertyScribe<? extends VCardProperty> getPropertyScribe(QName qname)

Gets a property scribe by XML local name and namespace.

Parameters:

qname - the XML local name and namespace

Returns:

the property scribe or a XmlScribe if not found

register

public void register(VCardPropertyScribe<? extends VCardProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe to register

unregister

public void unregister(VCardPropertyScribe<? extends VCardProperty> scribe)

Unregisters a property scribe.

Parameters:

scribe - the scribe to unregister