Package io.dialob.api.form

Class ModifiableFormMetadata

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

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

ModifiableFormMetadata is not thread-safe

See Also:

  • Method Details

    • create

      public static ModifiableFormMetadata create()
      Construct a modifiable instance of Metadata.
      Returns:
      A new modifiable instance

    • getLabel

      public final String getLabel()
      Specified by:
      getLabel in interface Form.Metadata
      Returns:
      value of label attribute, may be null

    • getCreated

      public final Date getCreated()
      Specified by:
      getCreated in interface Form.Metadata
      Returns:
      value of created attribute, may be null

    • getLastSaved

      public final Date getLastSaved()
      Specified by:
      getLastSaved in interface Form.Metadata
      Returns:
      value of lastSaved attribute, may be null

    • getValid

      public final Boolean getValid()
      Specified by:
      getValid in interface Form.Metadata
      Returns:
      value of valid attribute, may be null

    • getCreator

      public final String getCreator()
      Specified by:
      getCreator in interface Form.Metadata
      Returns:
      value of creator attribute, may be null

    • getTenantId

      public final String getTenantId()
      Specified by:
      getTenantId in interface Form.Metadata
      Returns:
      value of tenantId attribute, may be null

    • getSavedBy

      public final String getSavedBy()
      Specified by:
      getSavedBy in interface Form.Metadata
      Returns:
      value of savedBy attribute, may be null

    • getLabels

      public final Set<String> getLabels()
      Specified by:
      getLabels in interface Form.Metadata
      Returns:
      modifiable set labels

    • getDefaultSubmitUrl

      public final String getDefaultSubmitUrl()
      Specified by:
      getDefaultSubmitUrl in interface Form.Metadata
      Returns:
      value of defaultSubmitUrl attribute, may be null

    • getLanguages

      public final Set<String> getLanguages()
      Specified by:
      getLanguages in interface Form.Metadata
      Returns:
      modifiable set languages

    • getAdditionalProperties

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

    • clear

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

    • from

      public ModifiableFormMetadata from(Form.Metadata instance)
      Fill this modifiable instance with attribute values from the provided Form.Metadata 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 ModifiableFormMetadata from(ModifiableFormMetadata instance)
      Fill this modifiable instance with attribute values from the provided Form.Metadata 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

    • setLabel

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

    • setCreated

      public ModifiableFormMetadata setCreated(Date created)
      Assigns a value to the created attribute.
      Parameters:
      created - The value for created, can be null
      Returns:
      this for use in a chained invocation

    • setLastSaved

      public ModifiableFormMetadata setLastSaved(Date lastSaved)
      Assigns a value to the lastSaved attribute.
      Parameters:
      lastSaved - The value for lastSaved, can be null
      Returns:
      this for use in a chained invocation

    • setValid

      public ModifiableFormMetadata setValid(Boolean valid)
      Assigns a value to the valid attribute.
      Parameters:
      valid - The value for valid, can be null
      Returns:
      this for use in a chained invocation

    • setCreator

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

    • setTenantId

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

    • setSavedBy

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

    • addLabels

      public ModifiableFormMetadata addLabels(String element)
      Adds one element to labels set.
      Parameters:
      element - The labels element
      Returns:
      this for use in a chained invocation

    • addLabels

      public final ModifiableFormMetadata addLabels(String... elements)
      Adds elements to labels set.
      Parameters:
      elements - An array of labels elements
      Returns:
      this for use in a chained invocation

    • setLabels

      public ModifiableFormMetadata setLabels(Iterable<String> elements)
      Sets or replaces all elements for labels set.
      Parameters:
      elements - An iterable of labels elements
      Returns:
      this for use in a chained invocation

    • addAllLabels

      public ModifiableFormMetadata addAllLabels(Iterable<String> elements)
      Adds elements to labels set.
      Parameters:
      elements - An iterable of labels elements
      Returns:
      this for use in a chained invocation

    • setDefaultSubmitUrl

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

    • addLanguages

      public ModifiableFormMetadata addLanguages(String element)
      Adds one element to languages set.
      Parameters:
      element - The languages element
      Returns:
      this for use in a chained invocation

    • addLanguages

      public final ModifiableFormMetadata addLanguages(String... elements)
      Adds elements to languages set.
      Parameters:
      elements - An array of languages elements
      Returns:
      this for use in a chained invocation

    • setLanguages

      public ModifiableFormMetadata setLanguages(Iterable<String> elements)
      Sets or replaces all elements for languages set.
      Parameters:
      elements - An iterable of languages elements
      Returns:
      this for use in a chained invocation

    • addAllLanguages

      public ModifiableFormMetadata addAllLanguages(Iterable<String> elements)
      Adds elements to languages set.
      Parameters:
      elements - An iterable of languages elements
      Returns:
      this for use in a chained invocation

    • putAdditionalProperties

      public ModifiableFormMetadata 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 ModifiableFormMetadata 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 ModifiableFormMetadata 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

    • 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 ImmutableFormMetadata toImmutable()
      Converts to ImmutableFormMetadata.
      Returns:
      An immutable instance of Metadata

    • equals

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

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: label, created, lastSaved, valid, creator, tenantId, savedBy, labels, defaultSubmitUrl, languages, additionalProperties.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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