Package io.dialob.api.form

Class ImmutableFormValueSet.Builder

java.lang.Object
io.dialob.api.form.ImmutableFormValueSet.Builder
Enclosing class:
ImmutableFormValueSet
@NotThreadSafe public static final class ImmutableFormValueSet.Builder extends Object
Builds instances of type ImmutableFormValueSet. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

  • Method Details

    • from

      public final ImmutableFormValueSet.Builder from(ModifiableFormValueSet instance)
      Fill a builder with attribute values from the provided ModifiableFormValueSet instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      public final ImmutableFormValueSet.Builder from(FormValueSet instance)
      Fill a builder with attribute values from the provided FormValueSet instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • id

      public final ImmutableFormValueSet.Builder id(String id)
      Initializes the value for the id attribute.
      Parameters:
      id - The value for id (can be null)
      Returns:
      this builder for use in a chained invocation

    • addEntries

      public final ImmutableFormValueSet.Builder addEntries(@Nullable FormValueSetEntry element)
      Adds one element to entries list.
      Parameters:
      element - A entries element
      Returns:
      this builder for use in a chained invocation

    • addEntries

      public final ImmutableFormValueSet.Builder addEntries(FormValueSetEntry... elements)
      Adds elements to entries list.
      Parameters:
      elements - An array of entries elements
      Returns:
      this builder for use in a chained invocation

    • entries

      public final ImmutableFormValueSet.Builder entries(Iterable<? extends FormValueSetEntry> elements)
      Sets or replaces all elements for entries list.
      Parameters:
      elements - An iterable of entries elements
      Returns:
      this builder for use in a chained invocation

    • addAllEntries

      public final ImmutableFormValueSet.Builder addAllEntries(Iterable<? extends FormValueSetEntry> elements)
      Adds elements to entries list.
      Parameters:
      elements - An iterable of entries elements
      Returns:
      this builder for use in a chained invocation

    • putAdditionalProperties

      public final ImmutableFormValueSet.Builder putAdditionalProperties(@Nullable String key, @Nullable Object value)
      Put one entry to the additionalProperties map.
      Parameters:
      key - The key in the additionalProperties map
      value - The associated value in the additionalProperties map
      Returns:
      this builder for use in a chained invocation

    • putAdditionalProperties

      public final ImmutableFormValueSet.Builder putAdditionalProperties(Map.Entry<String,? extends Object> entry)
      Put one entry to the additionalProperties map. Nulls are not permitted
      Parameters:
      entry - The key and value entry
      Returns:
      this builder for use in a chained invocation

    • additionalProperties

      public final ImmutableFormValueSet.Builder additionalProperties(Map<String,? extends Object> entries)
      Sets or replaces all mappings from the specified map as entries for the additionalProperties map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the additionalProperties map
      Returns:
      this builder for use in a chained invocation

    • putAllAdditionalProperties

      public final ImmutableFormValueSet.Builder putAllAdditionalProperties(Map<String,? extends Object> entries)
      Put all mappings from the specified map as entries to additionalProperties map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the additionalProperties map
      Returns:
      this builder for use in a chained invocation

    • build

      public ImmutableFormValueSet build()
      Builds a new ImmutableFormValueSet.
      Returns:
      An immutable instance of FormValueSet
      Throws:
      IllegalStateException - if any required attributes are missing