com.github.mangstadt.vinnie.io

Interface VObjectDataListener

All Known Implementing Classes:

VObjectDataAdapter

public interface VObjectDataListener

Callback interface used by VObjectReader for handling data as it is parsed off the data stream.

Author:

Michael Angstadt

See Also:

VObjectReader.parse(com.github.mangstadt.vinnie.io.VObjectDataListener)

Method Summary

Modifier and Type	Method and Description
void	onComponentBegin(String name, Context context) Called when a component begins (in other words, when a BEGIN property is encountered).
void	onComponentEnd(String name, Context context) Called when a component ends (in other words, when an END property is encountered).
void	onProperty(VObjectProperty property, Context context) Called when a property is read.
void	onVersion(String value, Context context) Called when a VERSION property is read whose value and position (as defined in SyntaxRules) are recognized as valid.
void	onWarning(Warning warning, VObjectProperty property, Exception thrown, Context context) Called when a non-fatal error occurs during parsing.

Method Detail

onComponentBegin

void onComponentBegin(String name,
                      Context context)

Called when a component begins (in other words, when a BEGIN property is encountered).

Parameters:

name - the component name (will always be in uppercase)

context - the parse context

onComponentEnd

void onComponentEnd(String name,
                    Context context)

Called when a component ends (in other words, when an END property is encountered).

If a component ends before any of its subcomponents end, then the parser will generate "onComponentEnd" events for each subcomponent.

For example, the following data will cause the following sequence of events to occur. Notice that the outer component, A, ends before its subcomponents.

Data:

 BEGIN:A
 BEGIN:B
 BEGIN:C
 END:A
 END:C
 END:B
 

Sequence of events:

1. onComponentBegin(): name="A", parentComponents=[]
2. onComponentBegin(): name="B", parentComponents=["A"]
3. onComponentBegin(): name="C", parentComponents=["A", "B"]
4. onComponentEnd(): name="C", parentComponents=["A", "B"]
5. onComponentEnd(): name="B", parentComponents=["A"]
6. onComponentEnd(): name="A", parentComponents=[]
7. onWarning(): UNMATCHED_END
8. onWarning(): UNMATCHED_END

Parameters:

name - the component name (will always be in uppercase)

context - the parse context

onProperty

void onProperty(VObjectProperty property,
                Context context)

Called when a property is read.

Parameters:

property - the property

context - the parse context

onVersion

void onVersion(String value,
               Context context)

Called when a VERSION property is read whose value and position (as defined in SyntaxRules) are recognized as valid.

Parameters:

value - the version string

context - the parse context

onWarning

void onWarning(Warning warning,
               VObjectProperty property,
               Exception thrown,
               Context context)

Called when a non-fatal error occurs during parsing.

Parameters:

warning - the warning

property - the property that the warning is associated with, or null if the warning is not associated with a property

thrown - the exception that was thrown or null if no exception was thrown

context - the parse context