Package io.nosqlbench.nb.api.config.params

Class Synonyms

java.lang.Object
io.nosqlbench.nb.api.config.params.Synonyms
public class Synonyms
extends java.lang.Object
This class is just a central reference point for the names of parameters or other configuration-level primitives which have been given better names. For the sake of backwards compatibility, the old names are retained, but deprecated and warned against.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> PARAM_SYNONYMS
    Each entry in this list is a list of synonyms in configuration.

  • Constructor Summary

    Constructors 
    Constructor Description
    Synonyms()  

  • Method Summary

    Modifier and Type Method Description
    static java.lang.String canonicalize​(java.lang.String input, java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> synonyms, java.util.function.BiConsumer<java.lang.String,​java.lang.String> warnings)
    use this method to convert deprecated
    static java.lang.String canonicalize​(java.lang.String arg, org.apache.logging.log4j.Logger logger)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • PARAM_SYNONYMS

      public static final java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> PARAM_SYNONYMS
      Each entry in this list is a list of synonyms in configuration.

  • Constructor Details

  • Method Details

    • canonicalize

      public static java.lang.String canonicalize​(java.lang.String input, java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> synonyms, java.util.function.BiConsumer<java.lang.String,​java.lang.String> warnings)
      use this method to convert deprecated
      Parameters:
      input - A configuration string from a user or file
      synonyms - A list of known synonym lists with the preferred values first, like PARAM_SYNONYMS
      warnings - An BiConsumer which can handle (deprecated, preferred) for subsitutions.
      Returns:
      The configuration string in canonicalized form, with the preferred names used where possible

    • canonicalize

      public static java.lang.String canonicalize​(java.lang.String arg, org.apache.logging.log4j.Logger logger)