Package io.dialob.client.api

Class ImmutableFormDocument

    • Method Detail

      • getId

        @Nullable
public String getId()
        Specified by:
        getId in interface DialobDocument
        Returns:
        The value of the id attribute

      • getVersion

        @Nullable
public String getVersion()
        Specified by:
        getVersion in interface DialobDocument
        Returns:
        The value of the version attribute

      • withId

        public final ImmutableFormDocument withId​(@Nullable
                                          String value)
        Copy the current immutable object by setting a value for the id attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for id (can be null)
        Returns:
        A modified copy of the this object

      • withVersion

        public final ImmutableFormDocument withVersion​(@Nullable
                                               String value)
        Copy the current immutable object by setting a value for the version attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for version (can be null)
        Returns:
        A modified copy of the this object

      • withDescription

        public final ImmutableFormDocument withDescription​(@Nullable
                                                   String value)
        Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for description (can be null)
        Returns:
        A modified copy of the this object

      • withCreated

        public final ImmutableFormDocument withCreated​(LocalDateTime value)
        Copy the current immutable object by setting a value for the created attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for created
        Returns:
        A modified copy of the this object

      • withData

        public final ImmutableFormDocument withData​(io.dialob.api.form.Form value)
        Copy the current immutable object by setting a value for the data attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for data
        Returns:
        A modified copy of the this object

      • withUpdated

        public final ImmutableFormDocument withUpdated​(LocalDateTime value)
        Copy the current immutable object by setting a value for the updated attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for updated
        Returns:
        A modified copy of the this object

      • withType

        public final ImmutableFormDocument withType​(DialobDocument.DocumentType value)
        Copy the current immutable object by setting a value for the type attribute. A value equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for type
        Returns:
        A modified copy of the this object

      • withName

        public final ImmutableFormDocument withName​(String value)
        Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for name
        Returns:
        A modified copy of the this object

      • equals

        public boolean equals​(@Nullable
                      Object another)
        This instance is equal to all instances of ImmutableFormDocument 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: id, version, description, created, data, updated, type, name.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

        public String toString()
        Prints the immutable value FormDocument with attribute values.
        Overrides:
        toString in class Object
        Returns:
        A string representation of the value

      • copyOf

        public static ImmutableFormDocument copyOf​(DialobDocument.FormDocument instance)
        Creates an immutable copy of a DialobDocument.FormDocument value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
        Parameters:
        instance - The instance to copy
        Returns:
        A copied immutable FormDocument instance

      • builder

        public static ImmutableFormDocument.Builder builder()
        Creates a builder for ImmutableFormDocument. 
         ImmutableFormDocument.builder()
    .id(String | null) // nullable id
    .version(String | null) // nullable version
    .description(String | null) // nullable description
    .created(java.time.LocalDateTime) // required created
    .data(io.dialob.api.form.Form) // required data
    .updated(java.time.LocalDateTime) // required updated
    .type(io.dialob.client.api.DialobDocument.DocumentType) // optional type
    .name(String) // optional name
    .build();
        Returns:
        A new ImmutableFormDocument builder