io.ebeaninternal.server.deploy.BeanCollectionHelp Maven / Gradle / Ivy

Go to download

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

composite of common runtime dependencies for all platforms

There is a newer version: 15.10.0

package io.ebeaninternal.server.deploy;

import io.ebean.EbeanServer;
import io.ebean.Query;
import io.ebean.Transaction;
import io.ebean.bean.BeanCollection;
import io.ebean.bean.BeanCollectionAdd;
import io.ebean.bean.BeanCollectionLoader;
import io.ebean.bean.EntityBean;
import io.ebeaninternal.server.text.json.WriteJson;

import java.io.IOException;

/**
 * Helper functions for performing tasks on Lists Sets or Maps.
 */
public interface BeanCollectionHelp {

  /**
   * Set the EbeanServer that owns the configuration.
   */
  void setLoader(BeanCollectionLoader loader);

  /**
   * Return the mechanism to add beans to the underlying collection.
   * 
   * For Map's this needs to take the mapKey.
   * 
   */
  BeanCollectionAdd getBeanCollectionAdd(Object bc, String mapKey);

  /**
   * Create an empty collection of the correct type without a parent bean.
   */
  BeanCollection createEmptyNoParent();

  /**
   * Create an empty collection of the correct type.
   */
  BeanCollection createEmpty(EntityBean bean);

  /**
   * Add a bean to the List Set or Map.
   */
  void add(BeanCollection collection, EntityBean bean, boolean withCheck);

  /**
   * Create a lazy loading proxy for a List Set or Map.
   */
  BeanCollection createReference(EntityBean parentBean);

  /**
   * Refresh the List Set or Map.
   */
  void refresh(EbeanServer server, Query query, Transaction t, EntityBean parentBean);

  /**
   * Apply the new refreshed BeanCollection to the appropriate property of the parent bean.
   */
  void refresh(BeanCollection bc, EntityBean parentBean);

  /**
   * Write the collection out as json.
   */
  void jsonWrite(WriteJson ctx, String name, Object collection, boolean explicitInclude) throws IOException;

}