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

Class ImmutableFlowProgramStep

java.lang.Object
io.resys.hdes.client.api.programs.ImmutableFlowProgramStep
All Implemented Interfaces:
FlowProgram.FlowProgramStep, Serializable
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableFlowProgramStep extends Object implements FlowProgram.FlowProgramStep
Immutable implementation of FlowProgram.FlowProgramStep.

Use the builder to create immutable instances: ImmutableFlowProgramStep.builder().

See Also:

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface FlowProgram.FlowProgramStep
      Returns:
      The value of the id attribute

    • getPointer

      public FlowProgram.FlowProgramStepPointer getPointer()
      Specified by:
      getPointer in interface FlowProgram.FlowProgramStep
      Returns:
      The value of the pointer attribute

    • getBody

      @Nullable public FlowProgram.FlowProgramStepBody getBody()
      Specified by:
      getBody in interface FlowProgram.FlowProgramStep
      Returns:
      The value of the body attribute

    • withId

      public final ImmutableFlowProgramStep withId(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
      Returns:
      A modified copy of the this object

    • withPointer

      public final ImmutableFlowProgramStep withPointer(FlowProgram.FlowProgramStepPointer value)
      Copy the current immutable object by setting a value for the pointer attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for pointer
      Returns:
      A modified copy of the this object

    • withBody

      public final ImmutableFlowProgramStep withBody(@Nullable FlowProgram.FlowProgramStepBody value)
      Copy the current immutable object by setting a value for the body attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for body (can be null)
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableFlowProgramStep 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, pointer, body.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static ImmutableFlowProgramStep copyOf(FlowProgram.FlowProgramStep instance)
      Creates an immutable copy of a FlowProgram.FlowProgramStep 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 FlowProgramStep instance

    • builder

      public static ImmutableFlowProgramStep.Builder builder()
      Creates a builder for ImmutableFlowProgramStep. 
       ImmutableFlowProgramStep.builder()
    .id(String) // required id
    .pointer(io.resys.hdes.client.api.programs.FlowProgram.FlowProgramStepPointer) // required pointer
    .body(io.resys.hdes.client.api.programs.FlowProgram.FlowProgramStepBody | null) // nullable body
    .build();
      Returns:
      A new ImmutableFlowProgramStep builder