public class

AutoBeanVisitor

extends Object
java.lang.Object
   ↳ com.google.gwt.autobean.shared.AutoBeanVisitor

Class Overview

Allows traversal of an AutoBean object graph.

Summary

Nested Classes
interface AutoBeanVisitor.CollectionPropertyContext A PropertyContext that describes the parameterization of the Collection being visited. 
interface AutoBeanVisitor.Context Reserved for future expansion to avoid API breaks. 
interface AutoBeanVisitor.MapPropertyContext A PropertyContext that describes the parameterization of the Map being visited. 
interface AutoBeanVisitor.PropertyContext Allows properties to be reset. 
Public Constructors
AutoBeanVisitor()
Public Methods
void endVisit(AutoBean<?> bean, AutoBeanVisitor.Context ctx)
Called after visiting an AutoBean.
void endVisitCollectionProperty(String propertyName, AutoBean<Collection<?>> value, AutoBeanVisitor.CollectionPropertyContext ctx)
Called after visiting a reference property.
void endVisitMapProperty(String propertyName, AutoBean<Map<?, ?>> value, AutoBeanVisitor.MapPropertyContext ctx)
Called after visiting a reference property.
void endVisitReferenceProperty(String propertyName, AutoBean<?> value, AutoBeanVisitor.PropertyContext ctx)
Called after visiting a reference property.
void endVisitValueProperty(String propertyName, Object value, AutoBeanVisitor.PropertyContext ctx)
Called after visiting a value property.
boolean visit(AutoBean<?> bean, AutoBeanVisitor.Context ctx)
Called when visiting an AutoBean.
boolean visitCollectionProperty(String propertyName, AutoBean<Collection<?>> value, AutoBeanVisitor.CollectionPropertyContext ctx)
Called every time, but visit(AutoBean, Context) will be called for the value only the first time it is encountered.
boolean visitMapProperty(String propertyName, AutoBean<Map<?, ?>> value, AutoBeanVisitor.MapPropertyContext ctx)
Called every time, but visit(AutoBean, Context) will be called for the value only the first time it is encountered.
boolean visitReferenceProperty(String propertyName, AutoBean<?> value, AutoBeanVisitor.PropertyContext ctx)
Called every time, but visit(AutoBean, Context) will be called for the value only the first time it is encountered.
boolean visitValueProperty(String propertyName, Object value, AutoBeanVisitor.PropertyContext ctx)
TODO: document.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AutoBeanVisitor ()

Public Methods

public void endVisit (AutoBean<?> bean, AutoBeanVisitor.Context ctx)

Called after visiting an AutoBean.

Parameters
bean an AutoBean
ctx a Context

public void endVisitCollectionProperty (String propertyName, AutoBean<Collection<?>> value, AutoBeanVisitor.CollectionPropertyContext ctx)

Called after visiting a reference property.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext

public void endVisitMapProperty (String propertyName, AutoBean<Map<?, ?>> value, AutoBeanVisitor.MapPropertyContext ctx)

Called after visiting a reference property.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext

public void endVisitReferenceProperty (String propertyName, AutoBean<?> value, AutoBeanVisitor.PropertyContext ctx)

Called after visiting a reference property.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext

public void endVisitValueProperty (String propertyName, Object value, AutoBeanVisitor.PropertyContext ctx)

Called after visiting a value property.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext

public boolean visit (AutoBean<?> bean, AutoBeanVisitor.Context ctx)

Called when visiting an AutoBean.

Parameters
bean an AutoBean
ctx a Context

public boolean visitCollectionProperty (String propertyName, AutoBean<Collection<?>> value, AutoBeanVisitor.CollectionPropertyContext ctx)

Called every time, but visit(AutoBean, Context) will be called for the value only the first time it is encountered.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext

public boolean visitMapProperty (String propertyName, AutoBean<Map<?, ?>> value, AutoBeanVisitor.MapPropertyContext ctx)

Called every time, but visit(AutoBean, Context) will be called for the value only the first time it is encountered.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext

public boolean visitReferenceProperty (String propertyName, AutoBean<?> value, AutoBeanVisitor.PropertyContext ctx)

Called every time, but visit(AutoBean, Context) will be called for the value only the first time it is encountered.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext

public boolean visitValueProperty (String propertyName, Object value, AutoBeanVisitor.PropertyContext ctx)

TODO: document.

Parameters
propertyName the property name, as a String
value the property value
ctx a PropertyContext