public interface

ExtensionVisitor

com.google.gdata.data.ExtensionVisitor

Class Overview

The ExtensionVisitor interface describes the implementation of a visitor pattern for GData data model processing.

See Also

Summary

Nested Classes
class ExtensionVisitor.StoppedException The StoppedException is thrown by ExtensionVisitor instances to immediately exit from extension tree processing. 
Public Methods
abstract boolean visit(ExtensionPoint parent, Extension extension)
Called during ExtensionPoint tree traversal to allow the visitor instance to process an extension in the tree.
abstract void visitComplete(ExtensionPoint target)
The visitComplete method is called when traversal for an ExtensionPoint and all of its nested children has been completed.

Public Methods

public abstract boolean visit (ExtensionPoint parent, Extension extension)

Called during ExtensionPoint tree traversal to allow the visitor instance to process an extension in the tree.

Parameters
parent The parent of the visited extension.
extension The target extension being visited.
Returns
  • boolean value indicating whether child extensions (if any) should be visited.
Throws
ExtensionVisitor.StoppedException if the data model traversal should be stopped immediately. This may be the result of an unexpected error, or some visitor implementations may extend this exception type to signal specific exit conditions.

public abstract void visitComplete (ExtensionPoint target)

The visitComplete method is called when traversal for an ExtensionPoint and all of its nested children has been completed.

Parameters
target The visited extension point
Throws
ExtensionVisitor.StoppedException if the data model traversal should be stopped immediately. This may be the result of an unexpected error, or some visitor implementations may extend this exception type to signal specific exit conditions.