Package com.inductiveautomation.ignition.common.config

Class EnvironmentVariable.BulkBuilder

  • Enclosing class:
    EnvironmentVariable
    public static class EnvironmentVariable.BulkBuilder
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      BulkBuilder()
      Default constructor for BulkBuilder.
      BulkBuilder​(java.util.regex.Pattern envKeyPattern)
      Constructor for BulkBuilder that registers a single pattern.

    • Constructor Detail

      • BulkBuilder

        public BulkBuilder()
        Default constructor for BulkBuilder. You must register at least one pattern before calling build().

      • BulkBuilder

        public BulkBuilder​(java.util.regex.Pattern envKeyPattern)
        Constructor for BulkBuilder that registers a single pattern. You can register additional patterns with withPattern(Pattern).
        Parameters:
        envKeyPattern - RegEx Pattern object that will be used to match available Env Vars

    • Method Detail

      • withPattern

        public EnvironmentVariable.BulkBuilder withPattern​(java.util.regex.Pattern envKeyPattern)
        Use this to apply a regex pattern for matching environment variables to be retrieved. You must have at least one registered pattern for this builder. The first pattern to match will include a given environment variable.
        Parameters:
        envKeyPattern - RegEx Pattern object that will be used to match available Env Vars
        Returns:
        BulkBuilder object

      • withCustom

        public EnvironmentVariable.BulkBuilder withCustom​(java.util.function.Consumer<EnvironmentVariable.Builder> builderFunction)
        Use this to apply variable logic to customize each Env Var Builder that is accumulated by the Bulk Builder. This might be useful if you are retrieving a set of EnvironmentVariables that may need different properties applied to their Builders.
        Parameters:
        builderFunction - Custom Function that can apply additional customizations to EnvironmentVariable.Builder objects before build()
        Returns:
        BulkBuilder object

      • build

        public java.util.List<EnvironmentVariable> build()
        Build a list of EnvironmentVariables with all the variables that match the supplied pattern.
        Returns:
        List of resolved EnvironmentVariable objects