Package org.springframework.shell.test

Record Class ShellInputProvider

java.lang.Object
java.lang.Record
org.springframework.shell.test.ShellInputProvider
Record Components:
command - represents the command to be executed in the shell.
inputs - Queue containing user input strings.
passwords - Queue containing user password strings.
public record ShellInputProvider(String command, Deque<String> inputs, Deque<String> passwords) extends Record
Represents a provider for commands with their inputs and passwords used in shell interactions. This class uses two Deque instances to manage the queue of user inputs and passwords. It serves as a utility for simulating user input during testing or automated shell interactions.
Since:
4.0.2
Author:
David Pilar, Mahmoud Ben Hassine

  • Constructor Details

    • ShellInputProvider

      public ShellInputProvider(String command, Deque<String> inputs, Deque<String> passwords)
      Creates an instance of a ShellInputProvider record class.
      Parameters:
      command - the value for the command record component
      inputs - the value for the inputs record component
      passwords - the value for the passwords record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • command

      public String command()
      Returns the value of the command record component.
      Returns:
      the value of the command record component

    • inputs

      public Deque<String> inputs()
      Returns the value of the inputs record component.
      Returns:
      the value of the inputs record component

    • passwords

      public Deque<String> passwords()
      Returns the value of the passwords record component.
      Returns:
      the value of the passwords record component