com.github.mangstadt.vinnie.io

Class VObjectDataAdapter

java.lang.Object

com.github.mangstadt.vinnie.io.VObjectDataAdapter

All Implemented Interfaces:

VObjectDataListener

public class VObjectDataAdapter
extends Object
implements VObjectDataListener

Empty implementation of VObjectDataListener.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
VObjectDataAdapter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

VObjectDataAdapter

public VObjectDataAdapter()

Method Detail

onComponentBegin

public void onComponentBegin(String name,
                             Context context)

Description copied from interface: VObjectDataListener

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

Specified by:

onComponentBegin in interface VObjectDataListener

Parameters:

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

context - the parse context

onComponentEnd

public void onComponentEnd(String name,
                           Context context)

Description copied from interface: VObjectDataListener

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

Specified by:

onComponentEnd in interface VObjectDataListener

Parameters:

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

context - the parse context

onProperty

public void onProperty(VObjectProperty property,
                       Context context)

Description copied from interface: VObjectDataListener

Called when a property is read.

Specified by:

onProperty in interface VObjectDataListener

Parameters:

property - the property

context - the parse context

onVersion

public void onVersion(String value,
                      Context context)

Description copied from interface: VObjectDataListener

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

Specified by:

onVersion in interface VObjectDataListener

Parameters:

value - the version string

context - the parse context

onWarning

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

Description copied from interface: VObjectDataListener

Called when a non-fatal error occurs during parsing.

Specified by:

onWarning in interface VObjectDataListener

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