org.opentcs.components.plantoverview.PropertySuggestions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-api-base Show documentation

opentcs-api-base

There is a newer version: 6.2.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.components.plantoverview;

import jakarta.annotation.Nonnull;
import java.util.HashSet;
import java.util.Set;

/**
 * Objects implementing this interface provide a set for suggested property keys and values each.
 */
public interface PropertySuggestions {

  /**
   * Returns suggested property keys.
   *
   * @return Suggested property keys.
   */
  @Nonnull
  Set getKeySuggestions();

  /**
   * Returns suggested property values.
   *
   * @return Suggested property values.
   */
  @Nonnull
  Set getValueSuggestions();

  /**
   * Returns suggested property values that are specified for the key.
   *
   * @param key A key suggestion for which value suggestions are requested.
   * @return A set of property value suggestions.
   */
  default Set getValueSuggestionsFor(String key) {
    return new HashSet<>();
  }
}