biweekly.io.scribe

Class ScribeIndex

java.lang.Object

biweekly.io.scribe.ScribeIndex

public class ScribeIndex
extends Object

Manages a listing of component and property scribes. This is useful for injecting the scribes of any experimental components or properties you have defined into a reader or writer object. The same object instance can be reused and injected into multiple reader/writer classes.

Example:

 //init the index
 ScribeIndex index = new ScribeIndex();
 index.register(new CustomPropertyScribe());
 index.register(new AnotherCustomPropertyScribe());
 index.register(new CustomComponentScribe());
 
 //inject into a reader class
 ICalReader textReader = new ICalReader(...);
 textReader.setRegistrar(index);
 List<ICalendar> icals = new ArrayList<ICalendar>();
 ICalendar ical;
 while ((ical = textReader.readNext()) != null){
   icals.add(ical);
 }
 
 //inject the same instance in another reader/writer class
 JCalWriter writer = new JCalWriter(...);
 writer.setRegistrar(index);
 for (ICalendar ical : icals){
   writer.write(ical);
 }
 

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
ScribeIndex()

Method Summary

Methods

Modifier and Type	Method and Description
ICalComponentScribe<? extends ICalComponent>	getComponentScribe(Class<? extends ICalComponent> clazz) Gets a component scribe by class.
ICalComponentScribe<? extends ICalComponent>	getComponentScribe(ICalComponent component) Gets the appropriate component scribe for a given component instance.
ICalComponentScribe<? extends ICalComponent>	getComponentScribe(String componentName) Gets a component scribe by name.
static ICalendarScribe	getICalendarScribe() Convenience method for getting the scribe of the root iCalendar component ("VCALENDAR").
ICalPropertyScribe<? extends ICalProperty>	getPropertyScribe(Class<? extends ICalProperty> clazz) Gets a property scribe by class.
ICalPropertyScribe<? extends ICalProperty>	getPropertyScribe(ICalProperty property) Gets the appropriate property scribe for a given property instance.
ICalPropertyScribe<? extends ICalProperty>	getPropertyScribe(QName qname) Gets a property scribe by XML local name and namespace.
ICalPropertyScribe<? extends ICalProperty>	getPropertyScribe(String propertyName) Gets a property scribe by name.
void	hasScribesFor(ICalendar ical) Checks to see if this scribe index has scribes registered for all of the components/properties in an iCalendar object.
void	register(ICalComponentScribe<? extends ICalComponent> scribe) Registers a component scribe.
void	register(ICalPropertyScribe<? extends ICalProperty> scribe) Registers a property scribe.
void	unregister(ICalComponentScribe<? extends ICalComponent> scribe) Unregisters a component scribe.
void	unregister(ICalPropertyScribe<? extends ICalProperty> 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

getComponentScribe

public ICalComponentScribe<? extends ICalComponent> getComponentScribe(String componentName)

Gets a component scribe by name.

Parameters:

componentName - the component name (e.g. "VEVENT")

Returns:

the component scribe or a RawComponentScribe if not found

getPropertyScribe

public ICalPropertyScribe<? extends ICalProperty> getPropertyScribe(String propertyName)

Gets a property scribe by name.

Parameters:

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

Returns:

the property scribe or a RawPropertyScribe if not found

getComponentScribe

public ICalComponentScribe<? extends ICalComponent> getComponentScribe(Class<? extends ICalComponent> clazz)

Gets a component scribe by class.

Parameters:

clazz - the component class

Returns:

the component scribe or null if not found

getPropertyScribe

public ICalPropertyScribe<? extends ICalProperty> getPropertyScribe(Class<? extends ICalProperty> clazz)

Gets a property scribe by class.

Parameters:

clazz - the property class

Returns:

the property scribe or null if not found

getComponentScribe

public ICalComponentScribe<? extends ICalComponent> getComponentScribe(ICalComponent component)

Gets the appropriate component scribe for a given component instance.

Parameters:

component - the component instance

Returns:

the component scribe or null if not found

getPropertyScribe

public ICalPropertyScribe<? extends ICalProperty> getPropertyScribe(ICalProperty 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 ICalPropertyScribe<? extends ICalProperty> 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(ICalComponentScribe<? extends ICalComponent> scribe)

Registers a component scribe.

Parameters:

scribe - the scribe to register

register

public void register(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe to register

unregister

public void unregister(ICalComponentScribe<? extends ICalComponent> scribe)

Unregisters a component scribe.

Parameters:

scribe - the scribe to unregister

unregister

public void unregister(ICalPropertyScribe<? extends ICalProperty> scribe)

Unregisters a property scribe

Parameters:

scribe - the scribe to unregister

hasScribesFor

public void hasScribesFor(ICalendar ical)

Checks to see if this scribe index has scribes registered for all of the components/properties in an iCalendar object.

Parameters:

ical - the iCalendar object

Throws:

IllegalArgumentException - if the scribe index is missing scribes for one or more properties/components.

getICalendarScribe

public static ICalendarScribe getICalendarScribe()

Convenience method for getting the scribe of the root iCalendar component ("VCALENDAR").

Returns:

the scribe