Package io.resys.hdes.client.api.programs

Class ImmutableProgramMessage.Builder

java.lang.Object
io.resys.hdes.client.api.programs.ImmutableProgramMessage.Builder
Enclosing class:
ImmutableProgramMessage
@NotThreadSafe public static final class ImmutableProgramMessage.Builder extends Object
Builds instances of type ImmutableProgramMessage. 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

      @CanIgnoreReturnValue public final ImmutableProgramMessage.Builder from(ProgramEnvir.ProgramMessage instance)
      Fill a builder with attribute values from the provided ProgramMessage instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • id

      @CanIgnoreReturnValue public final ImmutableProgramMessage.Builder id(String id)
      Initializes the value for the id attribute.
      Parameters:
      id - The value for id
      Returns:
      this builder for use in a chained invocation

    • msg

      @CanIgnoreReturnValue public final ImmutableProgramMessage.Builder msg(String msg)
      Initializes the value for the msg attribute.
      Parameters:
      msg - The value for msg
      Returns:
      this builder for use in a chained invocation

    • row

      @CanIgnoreReturnValue public final ImmutableProgramMessage.Builder row(@Nullable Integer row)
      Initializes the value for the row attribute.
      Parameters:
      row - The value for row (can be null)
      Returns:
      this builder for use in a chained invocation

    • column

      @CanIgnoreReturnValue public final ImmutableProgramMessage.Builder column(@Nullable Integer column)
      Initializes the value for the column attribute.
      Parameters:
      column - The value for column (can be null)
      Returns:
      this builder for use in a chained invocation

    • exception

      @CanIgnoreReturnValue public final ImmutableProgramMessage.Builder exception(@Nullable Exception exception)
      Initializes the value for the exception attribute.
      Parameters:
      exception - The value for exception (can be null)
      Returns:
      this builder for use in a chained invocation

    • build

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