io.ebean.FetchPath 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.8.1

package io.ebean;

import java.util.Set;

/**
 * Provides paths and properties for an object graph that can be used to control what parts of the object graph
 * is fetching (select and fetch clauses) and also can be used to control JSON marshalling (what parts of the object
 * graph are included in the JSON).
 */
public interface FetchPath {

  /**
   * Return true if the path is included in this FetchPath.
   */
  boolean hasPath(String path);

  /**
   * Return the properties at the given path.
   */
  Set getProperties(String path);

  /**
   * Apply the fetch path to the query.
   */
   void apply(Query query);
}