jfxtras.icalendarfx.components

Class VComponentBase

java.lang.Object

jfxtras.icalendarfx.VParentBase

jfxtras.icalendarfx.components.VComponentBase

All Implemented Interfaces:

VComponent, VChild, VElement, VParent

Direct Known Subclasses:

VCommon

public abstract class VComponentBase
extends VParentBase
implements VComponent

<p>Base class implementation of a VComponent</p>

Method Summary

Modifier and Type	Method and Description
void	copyInto(VParent destination) Copy this VParent into destination VParent
VParent	getParent() Gets the VParent of this VChild
java.lang.String	name() <p>Returns the name of the component as it would appear in the iCalendar content line.</p> <p>Examples: <ul> <li>VEVENT <li>SUMMARY <li>LANGUAGE </ul> </p>
java.util.List<java.lang.String>	parseContent(java.lang.String content) Parse content line into calendar element.
java.util.Map<VElement,java.util.List<java.lang.String>>	parseContent(java.lang.String content, boolean useRequestStatus)
java.util.Map<VElement,java.util.List<java.lang.String>>	parseContent(UnfoldingStringIterator unfoldedLineIterator, boolean collectErrorMessages) Parse a VComponent from a Iterator&lt;String&gt;.
void	setParent(VParent parent) Set the VParent of this VChild.
java.lang.String	toString()

Methods inherited from class jfxtras.icalendarfx.VParentBase

childrenUnmodifiable, copyIntoCallback, equals, errors, hashCode, orderer, setContentLineGenerator, toContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface jfxtras.icalendarfx.components.VComponent

toContent

Methods inherited from interface jfxtras.icalendarfx.VParent

childrenUnmodifiable

Methods inherited from interface jfxtras.icalendarfx.VElement

errors, isValid

Method Detail

setParent

public void setParent(VParent parent)

Description copied from interface: VChild

Set the VParent of this VChild. This method is invoked internally by the API. Under normal circumstances it should not be used externally

Specified by:

setParent in interface VChild

getParent

public VParent getParent()

Description copied from interface: VChild

Gets the VParent of this VChild

Specified by:

getParent in interface VChild

copyInto

public void copyInto(VParent destination)

Description copied from interface: VParent

Copy this VParent into destination VParent

Specified by:

copyInto in interface VParent

Overrides:

copyInto in class VParentBase

name

public java.lang.String name()

Description copied from interface: VElement

<p>Returns the name of the component as it would appear in the iCalendar content line.</p> <p>Examples: <ul> <li>VEVENT <li>SUMMARY <li>LANGUAGE </ul> </p>

Specified by:

name in interface VElement

Returns:

parseContent

public java.util.List<java.lang.String> parseContent(java.lang.String content)

Description copied from interface: VElement

Parse content line into calendar element. If element contains children VElement.parseContent(String) is invoked recursively to parse child elements also

Specified by:

parseContent in interface VElement

Parameters:

content - calendar content string to parse

Returns:

log of information and error messages

parseContent

public java.util.Map<VElement,java.util.List<java.lang.String>> parseContent(java.lang.String content,
                                                                             boolean useRequestStatus)

parseContent

public java.util.Map<VElement,java.util.List<java.lang.String>> parseContent(UnfoldingStringIterator unfoldedLineIterator,
                                                                             boolean collectErrorMessages)

Description copied from interface: VComponent

Parse a VComponent from a Iterator<String>. Returns list of error strings for RequestStatus if collectErrorList is true, otherwise returns an empty list

Specified by:

parseContent in interface VComponent

Parameters:

unfoldedLineIterator - calendar component lines to parse

collectErrorMessages - true causes return List to contain error messages, false causes empty list

Returns:

list of error messages if collectErrorMessages is true, otherwise empty list

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object