io.annot8.api.helpers.builders.WithPropertiesBuilder Maven / Gradle / Ivy

Go to download
/* Annot8 (annot8.io) - Licensed under Apache-2.0. */
package io.annot8.api.helpers.builders;

import io.annot8.api.properties.Properties;
import java.util.Optional;

/**
 * Helper interface to indicate that a builder should processor adding properties to an object
 *
 * @param  The builder class
 */
public interface WithPropertiesBuilder {

  /**
   * Add a property
   *
   * @param key the key
   * @param value the value
   * @return a builder with the key-value property pair added to it
   */
  A withProperty(final String key, final Object value);

  /**
   * Add a property, if it is present (don't add it otherwise)
   *
   * @param key the key
   * @param value the value
   * @return a builder with the key-value property pair added to it, if the value is present
   */
  default A withPropertyIfPresent(final String key, final Optional value) {
    if (value.isPresent()) {
      return withProperty(key, value);
    }

    return (A) this;
  }

  /**
   * Add a property, if some condition is true (don't add it otherwise)
   *
   * @param key the key
   * @param value the value
   * @param condition property is only added if this evaluates to true
   * @return a builder with the key-value property pair added to it, if the condition is met
   */
  default A withPropertyIf(final String key, final Object value, boolean condition) {
    if (condition) {
      return withProperty(key, value);
    }

    return (A) this;
  }

  /**
   * Remove a property with matching key and value
   *
   * @param key the key to remove
   * @param value the value to remove
   * @return a builder with the key-value property pair removed from it
   */
  A withoutProperty(final String key, final Object value);

  /**
   * Remove a property
   *
   * @param key the key to remove
   * @return a builder with the key removed from it
   */
  A withoutProperty(final String key);

  /**
   * Add in existing properties
   *
   * @param properties to add
   * @return a builder with the specified properties
   */
  A withProperties(final Properties properties);
}