Package uk.ac.diamond.daq.configuration

Record Class ConfigurationOptions

java.lang.Object
java.lang.Record
uk.ac.diamond.daq.configuration.ConfigurationOptions
public record ConfigurationOptions(Stream<String> options, ConfigurationOptions.Action action) extends Record
Wrapper around a stream of Strings that also indicates whether subsequent options from other sources should be included.

  • Constructor Details

    • ConfigurationOptions

      public ConfigurationOptions(Stream<String> options, ConfigurationOptions.Action action)
      Creates an instance of a ConfigurationOptions record class.
      Parameters:
      options - the value for the options record component
      action - the value for the action record component

  • Method Details

    • merge

      public ConfigurationOptions merge(ConfigurationOptions other)
      Merge another stream of options into this one

      The resultant stream will either be this stream if it is set to overwrite (and should therefore ignore any subsequent options) or a new stream combining the options from both streams and the overwrite behaviour of the merged options.

      Parameters:
      other - The other ConfigurationOptions to be merged into this one
      Returns:
      A new ConfigurationOptions that reflects the combination of the two streams

    • effectiveOptions

      public static Stream<String> effectiveOptions(Collection<ConfigurationSource> sources, Function<ConfigurationSource,ConfigurationOptions> extract)

    • empty

      public static ConfigurationOptions empty()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • options

      public Stream<String> options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component

    • action

      public ConfigurationOptions.Action action()
      Returns the value of the action record component.
      Returns:
      the value of the action record component