biweekly.io.scribe.component

Class ICalComponentScribe<T extends ICalComponent>

java.lang.Object

biweekly.io.scribe.component.ICalComponentScribe<T>

Type Parameters:

T - the component class

Direct Known Subclasses:

ICalendarScribe, ObservanceScribe, RawComponentScribe, VAlarmScribe, VEventScribe, VFreeBusyScribe, VJournalScribe, VTimezoneScribe, VTodoScribe

public abstract class ICalComponentScribe<T extends ICalComponent>
extends Object

Base class for iCalendar component scribes.

Author:

Michael Angstadt

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<T>	clazz
protected String	componentName

Constructor Summary

Constructors

Constructor and Description
ICalComponentScribe(Class<T> clazz, String componentName) Creates a new component scribe.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract T	_newInstance() Creates a new instance of the component class.
T	emptyInstance() Creates a new instance of the component class that doesn't have any properties or sub-components.
Class<T>	getComponentClass() Gets the component class.
String	getComponentName() Gets the component's name.
Collection<ICalComponent>	getComponents(T component) Gets the sub-components to marshal.
List<ICalProperty>	getProperties(T component) Gets the properties to marshal.
Set<ICalVersion>	getSupportedVersions() Gets the iCalendar versions that support this component.

Methods inherited from class java.lang.Object

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

Field Detail

clazz

protected final Class<T extends ICalComponent> clazz

componentName

protected final String componentName

Constructor Detail

ICalComponentScribe

public ICalComponentScribe(Class<T> clazz,
                   String componentName)

Creates a new component scribe.

Parameters:

clazz - the component's class

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

Method Detail

getSupportedVersions

public Set<ICalVersion> getSupportedVersions()

Gets the iCalendar versions that support this component. This method returns all iCalendar versions unless overridden by the child scribe.

Returns:

the iCalendar versions

getComponentClass

public Class<T> getComponentClass()

Gets the component class.

Returns:

the component class.

getComponentName

public String getComponentName()

Gets the component's name.

Returns:

the compent's name (e.g. "VEVENT")

emptyInstance

public T emptyInstance()

Creates a new instance of the component class that doesn't have any properties or sub-components.

Returns:

the new instance

_newInstance

protected abstract T _newInstance()

Creates a new instance of the component class.

Returns:

the new instance

getComponents

public Collection<ICalComponent> getComponents(T component)

Gets the sub-components to marshal. Child classes can override this for better control over which components are marshalled.

Parameters:

component - the component

Returns:

the sub-components to marshal

getProperties

public List<ICalProperty> getProperties(T component)

Gets the properties to marshal. Child classes can override this for better control over which properties are marshalled.

Parameters:

component - the component

Returns:

the properties to marshal