com.avaje.ebeaninternal.server.ddl.BeanVisitor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

Ebean

There is a newer version: 2.8.1

package com.avaje.ebeaninternal.server.ddl;

import com.avaje.ebeaninternal.server.deploy.BeanDescriptor;
import com.avaje.ebeaninternal.server.deploy.BeanProperty;

/**
 * Visitor pattern for visiting a BeanDescriptor and potentially all its bean
 * properties.
 */
public interface BeanVisitor {

	/**
	 * Starting.
	 */
	public void visitBegin();

	/**
	 * Visit a BeanDescriptor and return true to continue visiting the bean
	 * (return false to skip visiting this bean).
	 */
	public boolean visitBean(BeanDescriptor descriptor);

	/**
	 * Visit a property potentially return a specific PropertyVisitor.
	 * 
	 * A PropertyVisitor can be returned to more easily process bean properties
	 * by their specific type.
	 * 
	 */
	public PropertyVisitor visitProperty(BeanProperty p);

	/**
	 * Finished visiting the BeanDescriptor.
	 */
	public void visitBeanEnd(BeanDescriptor descriptor);

	/**
	 * Finished all visiting.
	 */
	public void visitEnd();

}