Package pl.poznan.put.utility

Class ImmutableExecutionResult

java.lang.Object
pl.poznan.put.utility.ImmutableExecutionResult
All Implemented Interfaces:
ExecHelper.ExecutionResult
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable public final class ImmutableExecutionResult extends Object implements ExecHelper.ExecutionResult
Immutable implementation of ExecHelper.ExecutionResult.

Use the builder to create immutable instances: ImmutableExecutionResult.builder(). Use the static factory method to create immutable instances: ImmutableExecutionResult.of().

  • Method Details

    • exitCode

      public int exitCode()
      Specified by:
      exitCode in interface ExecHelper.ExecutionResult
      Returns:
      The exit code (0 means success).

    • standardOutput

      public String standardOutput()
      Specified by:
      standardOutput in interface ExecHelper.ExecutionResult
      Returns:
      The contents of standard output stream.

    • standardError

      public String standardError()
      Specified by:
      standardError in interface ExecHelper.ExecutionResult
      Returns:
      The contents of standard error stream.

    • withExitCode

      public final ImmutableExecutionResult withExitCode(int value)
      Copy the current immutable object by setting a value for the exitCode attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for exitCode
      Returns:
      A modified copy of the this object

    • withStandardOutput

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

    • withStandardError

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

    • equals

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

    • toString

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

    • of

      public static ImmutableExecutionResult of(int exitCode, String standardOutput, String standardError)
      Construct a new immutable ExecutionResult instance.
      Parameters:
      exitCode - The value for the exitCode attribute
      standardOutput - The value for the standardOutput attribute
      standardError - The value for the standardError attribute
      Returns:
      An immutable ExecutionResult instance

    • copyOf

      public static ImmutableExecutionResult copyOf(ExecHelper.ExecutionResult instance)
      Creates an immutable copy of a ExecHelper.ExecutionResult 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 ExecutionResult instance

    • builder

      public static ImmutableExecutionResult.Builder builder()
      Creates a builder for ImmutableExecutionResult. 
       ImmutableExecutionResult.builder()
    .exitCode(int) // required exitCode
    .standardOutput(String) // required standardOutput
    .standardError(String) // required standardError
    .build();
      Returns:
      A new ImmutableExecutionResult builder