Package io.nosqlbench.nb.api.config.standard

Class NBConfiguration

java.lang.Object
io.nosqlbench.nb.api.config.standard.NBConfiguration
public class NBConfiguration
extends java.lang.Object

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected NBConfiguration​(NBConfigModel model, java.util.LinkedHashMap<java.lang.String,​java.lang.Object> validConfig)
    Create a NBConfigReader from a known valid configuration and a config model.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String get​(java.lang.String name)  
    <T> T get​(java.lang.String name, java.lang.Class<? extends T> type)  
    java.util.Optional<java.lang.String> getEnvOptional​(java.lang.String name)
    Returns the value of the named parameter as getOptional(String), so long as no env vars were reference OR all env var references were found.
    java.util.Map<java.lang.String,​java.lang.Object> getMap()  
    <T> java.util.Optional<T> getOptional​(java.lang.Class<T> type, java.lang.String... names)  
    java.util.Optional<java.lang.String> getOptional​(java.lang.String name)  
    java.util.Optional<java.lang.String> getOptional​(java.lang.String... names)  
    <T> T getOrDefault​(java.lang.String name, T defaultValue)  
    java.lang.String getWithEnv​(java.lang.String name)  
    <T> T getWithEnv​(java.lang.String name, java.lang.Class<? extends T> vclass)  
    boolean isEmpty()  
    <T> T param​(java.lang.String name, java.lang.Class<? extends T> vclass)  
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • NBConfiguration

      protected NBConfiguration​(NBConfigModel model, java.util.LinkedHashMap<java.lang.String,​java.lang.Object> validConfig)
      Create a NBConfigReader from a known valid configuration and a config model. This method is restricted to encourage construction of readers only by passing through the friendly NBConfigModel.apply(Map) method.
      Parameters:
      model - A configuration model, describing what is allowed to be configured by name and type.
      validConfig - A valid config reader.

  • Method Details

    • getEnvOptional

      public java.util.Optional<java.lang.String> getEnvOptional​(java.lang.String name)
      Returns the value of the named parameter as getOptional(String), so long as no env vars were reference OR all env var references were found.
      Parameters:
      name - The name of the variable to look up
      Returns:
      An optional value, if present and (optionally) interpolated correctly from the environment

    • getWithEnv

      public java.lang.String getWithEnv​(java.lang.String name)

    • getWithEnv

      public <T> T getWithEnv​(java.lang.String name, java.lang.Class<? extends T> vclass)

    • get

      public java.lang.String get​(java.lang.String name)

    • get

      public <T> T get​(java.lang.String name, java.lang.Class<? extends T> type)

    • getOptional

      public java.util.Optional<java.lang.String> getOptional​(java.lang.String name)

    • getOptional

      public java.util.Optional<java.lang.String> getOptional​(java.lang.String... names)

    • getOptional

      public <T> java.util.Optional<T> getOptional​(java.lang.Class<T> type, java.lang.String... names)

    • getOrDefault

      public <T> T getOrDefault​(java.lang.String name, T defaultValue)

    • param

      public <T> T param​(java.lang.String name, java.lang.Class<? extends T> vclass)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • isEmpty

      public boolean isEmpty()

    • getMap

      public java.util.Map<java.lang.String,​java.lang.Object> getMap()