io.avaje.json.view.ViewBuilderAware Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of avaje-json Show documentation

There is a newer version: 3.0-RC2

package io.avaje.json.view;

import java.lang.invoke.MethodHandle;

/**
 * A (non-scalar) JsonAdapter that is part of building json views.
 * 
 * JsonAdapters for complex types that have more than one property like
 * CustomerJsonAdapter, AddressJsonAdapter can participate in building
 * a json view that will include only some of their properties.
 */
public interface ViewBuilderAware {

  /**
   * Build view for the top level.
   */
  default void build(ViewBuilder builder) {
    build(builder, null, null);
  }

  /**
   * Build nested part of the view.
   */
  void build(ViewBuilder builder, String name, MethodHandle handle);

}