Package io.dialob.api.form

Class ModifiableFormValueSetEntry

java.lang.Object
io.dialob.api.form.ModifiableFormValueSetEntry
All Implemented Interfaces:
FormValueSetEntry, Serializable
@ParametersAreNonnullByDefault @Generated({"Modifiables.generator","FormValueSetEntry"}) @NotThreadSafe public final class ModifiableFormValueSetEntry extends Object implements FormValueSetEntry
A modifiable implementation of the FormValueSetEntry type.

Use the create() static factory methods to create new instances. Use the toImmutable() method to convert to canonical immutable instances.

ModifiableFormValueSetEntry is not thread-safe

See Also:

  • Method Details

    • create

      public static ModifiableFormValueSetEntry create()
      Construct a modifiable instance of FormValueSetEntry.
      Returns:
      A new modifiable instance

    • getId

      public final String getId()
      Specified by:
      getId in interface FormValueSetEntry
      Returns:
      value of id attribute

    • getLabel

      public final Map<String,String> getLabel()
      Specified by:
      getLabel in interface FormValueSetEntry
      Returns:
      value of label attribute

    • getWhen

      public final String getWhen()
      Specified by:
      getWhen in interface FormValueSetEntry
      Returns:
      value of when attribute, may be null

    • getAdditionalProperties

      public final Map<String,Object> getAdditionalProperties()
      Specified by:
      getAdditionalProperties in interface FormValueSetEntry
      Returns:
      value of additionalProperties attribute

    • clear

      public ModifiableFormValueSetEntry clear()
      Clears the object by setting all attributes to their initial values.
      Returns:
      this for use in a chained invocation

    • from

      public ModifiableFormValueSetEntry from(FormValueSetEntry instance)
      Fill this modifiable instance with attribute values from the provided FormValueSetEntry instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values). Collection elements and entries will be added, not replaced.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this for use in a chained invocation

    • from

      public ModifiableFormValueSetEntry from(ModifiableFormValueSetEntry instance)
      Fill this modifiable instance with attribute values from the provided FormValueSetEntry instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values). Collection elements and entries will be added, not replaced.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this for use in a chained invocation

    • setId

      public ModifiableFormValueSetEntry setId(String id)
      Assigns a value to the id attribute.
      Parameters:
      id - The value for id
      Returns:
      this for use in a chained invocation

    • putLabel

      public ModifiableFormValueSetEntry putLabel(String key, String value)
      Put one entry to the label map.
      Parameters:
      key - The key in label map
      value - The associated value in the label map
      Returns:
      this for use in a chained invocation

    • setLabel

      public ModifiableFormValueSetEntry setLabel(Map<String,? extends String> entries)
      Sets or replaces all mappings from the specified map as entries for the label map. Nulls are not permitted as keys or values.
      Parameters:
      entries - The entries that will be added to the label map
      Returns:
      this for use in a chained invocation

    • putAllLabel

      public ModifiableFormValueSetEntry putAllLabel(Map<String,? extends String> entries)
      Put all mappings from the specified map as entries to the label map. Nulls are not permitted as keys or values.
      Parameters:
      entries - to be added to label map
      Returns:
      this for use in a chained invocation

    • setWhen

      public ModifiableFormValueSetEntry setWhen(String when)
      Assigns a value to the when attribute.
      Parameters:
      when - The value for when, can be null
      Returns:
      this for use in a chained invocation

    • putAdditionalProperties

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

    • setAdditionalProperties

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

    • putAllAdditionalProperties

      public ModifiableFormValueSetEntry putAllAdditionalProperties(Map<String,? extends Object> entries)
      Put all mappings from the specified map as entries to the additionalProperties map. Nulls are not permitted as keys or values.
      Parameters:
      entries - to be added to additionalProperties map
      Returns:
      this for use in a chained invocation

    • idIsSet

      public final boolean idIsSet()
      Returns true if the required attribute id is set.
      Returns:
      true if set

    • unsetId

      public final ModifiableFormValueSetEntry unsetId()
      Reset an attribute to its initial value.
      Returns:
      this for use in a chained invocation

    • isInitialized

      public final boolean isInitialized()
      Returns true if all required attributes are set, indicating that the object is initialized.
      Returns:
      true if set

    • toImmutable

      public final ImmutableFormValueSetEntry toImmutable()
      Converts to ImmutableFormValueSetEntry.
      Returns:
      An immutable instance of FormValueSetEntry

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ModifiableFormValueSetEntry that have equal attribute values. An uninitialized instance is equal only to itself.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: id, label, when, additionalProperties.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Generates a string representation of this FormValueSetEntry. If uninitialized, some attribute values may appear as question marks.
      Overrides:
      toString in class Object
      Returns:
      A string representation