com.blazebit.query.spi.QueryContextBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of blaze-query-core-api Show documentation
A multi-platform querying library
The newest version!
/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Blazebit
 */
package com.blazebit.query.spi;

import com.blazebit.query.QueryContext;

/**
 * Builder for the Blaze-Query {@link QueryContext}.
 *
 * @author Christian Beikov
 * @since 1.0.0
 */
public interface QueryContextBuilder {

	/**
	 * Constructs a property provider for the value and registers it via {@link #setPropertyProvider(String, PropertyProvider)}.
	 *
	 * @param property The property name
	 * @param value The property value
	 * @return {@code this} object for method chaining
	 */
	QueryContextBuilder setProperty(String property, Object value);

	/**
	 * Sets the given supplier as value provider for the given property name.
	 *
	 * @param property The property name
	 * @param provider The property value provider
	 * @return {@code this} object for method chaining
	 */
	QueryContextBuilder setPropertyProvider(String property, PropertyProvider provider);

	/**
	 * Returns the property provider for the property name.
	 *
	 * @param property The property name
	 * @param  The expected value type
	 * @return the property provider for the property name
	 * @throws IllegalArgumentException If no property provider exists
	 */
	 PropertyProvider getPropertyProvider(String property);

	/**
	 * Registers a fully qualified alias for a schema object type.
	 *
	 * @param schemaObjectType The schema object type
	 * @param alias The qualified alias name
	 * @return {@code this} object for method chaining
	 */
	QueryContextBuilder registerSchemaObjectAlias(Class schemaObjectType, String alias);

	/**
	 * Registers the data fetcher for a schema object type.
	 *
	 * @param schemaObjectType The schema object type
	 * @param dataFetcher The data fetcher
	 * @param  The schema object type
	 * @return {@code this} object for method chaining
	 */
	 QueryContextBuilder registerSchemaObject(Class schemaObjectType, DataFetcher dataFetcher);

	/**
	 * Registers a {@link QuerySchemaProvider} to provide schema objects.
	 *
	 * @param querySchemaProvider The {@link QuerySchemaProvider} to register
	 * @return The updated {@link QueryContextBuilder} object
	 */
	QueryContextBuilder registerSchemaProvider(QuerySchemaProvider querySchemaProvider);

	/**
	 * Loads the available services through the Java {@link java.util.ServiceLoader} API.
	 *
	 * @return {@code this} object for method chaining
	 */
	QueryContextBuilder loadServices();

	/**
	 * Builds a new {@link QueryContext} object based on the configuration provided by this builder.
	 *
	 * @return A new {@link QueryContext}
	 */
	QueryContext build();
}