io.ebean.text.json.JsonWriteBeanVisitor Maven / Gradle / Ivy

Go to download

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

ebean api

There is a newer version: 15.8.0

package io.ebean.text.json;

/**
 * Allows for customising the JSON write processing.
 * 
 * You can use this to add raw JSON content via {@link JsonWriter}.
 * 

 * You register a JsonWriteBeanVisitor with {@link JsonWriteOptions}.
 * 
 *
 * @param  the type of entity bean
 * @see JsonWriteOptions
 */
public interface JsonWriteBeanVisitor {

  /**
   * Visit the bean that has just been writing it's content to JSON. You can
   * write your own additional JSON content to the JsonWriter if you wish.
   *
   * @param bean       the bean that has been writing it's content
   * @param jsonWriter the JsonWriter which you can append custom json content to if you
   *                   wish.
   */
  void visit(T bean, JsonWriter jsonWriter);

}