org.hibernate.search.engine.cfg.spi.OptionalConfigurationProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-engine Show documentation
Hibernate Search engine, always required
The newest version!
/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Red Hat Inc. and Hibernate Authors
 */
package org.hibernate.search.engine.cfg.spi;

import java.util.Optional;
import java.util.function.Function;
import java.util.function.Supplier;

import org.hibernate.search.engine.cfg.ConfigurationPropertySource;

public interface OptionalConfigurationProperty extends ConfigurationProperty> {

	/**
	 * Get and transform the value of this configuration property.
	 * 
	 * Similar to calling {@link #getAndTransform(ConfigurationPropertySource, Function)},
	 * but easier to use, since the transform function is applied to the content of the optional,
	 * not to the optional itself.
	 * 

	 * Any exception occurring during transformation will be wrapped in another exception adding some context,
	 * such as the {@link #resolveOrRaw(ConfigurationPropertySource) resolved key} for this property.
	 *
	 * @param source A configuration source.
	 * @param transform A transform function to be applied to the value of this configuration property
	 * before returning the result.
	 * @param  The transformed type.
	 * @return The value of this property according to the given source.
	 */
	 Optional getAndMap(ConfigurationPropertySource source, Function transform);

	/**
	 * Get the value of this configuration property, throwing an exception if the value is not present.
	 *
	 * @param source A configuration source.
	 * @param exceptionSupplier A supplier that will be called to create an exception if the value is missing.
	 * to create an exception if the value is missing.
	 * @return The value of this property according to the given source.
	 */
	T getOrThrow(ConfigurationPropertySource source, Supplier exceptionSupplier);

	/**
	 * Get and transform the value of this configuration property, throwing an exception if the value is not present.
	 * 
	 * Any exception occurring during transformation will be wrapped in another exception adding some context,
	 * such as the {@link #resolveOrRaw(ConfigurationPropertySource) resolved key} for this property.
	 *
	 * @param  The transformed type.
	 * @param source A configuration source.
	 * @param transform A transform function to be applied to the value of this configuration property
	 * before returning the result.
	 * @param exceptionSupplier A supplier that will be called to create an exception if the value is missing.
	 * @return The value of this property according to the given source.
	 */
	 R getAndMapOrThrow(ConfigurationPropertySource source, Function transform,
			Supplier exceptionSupplier);

}