ReadMe

Deutsch / German

Installation

• Downloads:

  • JDK: Java Development Kit
  • Visual Studio Code: Visual Studio Code Download

• Installation:

  • Folgen Sie den Anweisungen des JDK-Installers.
  • In VS Code unter Extensions laden Sie das Paket Extension Pack for Java von Microsoft herunter, indem Sie ⇧ + ⌘ + X oder STRG + ⇧ + X drücken und danach suchen.

Beschreibung des Codes

• Importieren der Bibliotheken:

    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.Map;
    import java.util.Scanner;

  Die Bibliotheken:

  • ArrayList ist für die Listenerstellung erforderlich.
  • HashMap & Map ermöglichen die Erstellung einer Hash-Map zur effizienten und schnellen Ausführung der Commands.
  • Scanner wird für die Eingabeüberwachung verwendet.

• Array und Hash-Map:

    ArrayList<String> bucket = new ArrayList<>();
    Scanner reader = new Scanner(System.in);
  
    Map<String, Runnable> commandActions = new HashMap<>();

  Das Programm verwendet Arrays zur Speicherung der Benutzereingaben. Diese Eingaben werden als Strings gespeichert. Das Array-Objekt bucket speichert alle Eingaben des Benutzers, die als Tasks ausgegeben werden können. Die Hash-Map ermöglicht die schnelle Zuordnung von Werten und verknüpften Aktionen, im Gegensatz zu linearen Suchsystemen, die bei vielen Objekten ineffizient sein können.

• While-Schleife zur stetigen Abfrage von Commands:

    while (true) {
      System.out.print("Input: ");
      String input = reader.nextLine();
      if (commandActions.containsKey(input)) {  
        commandActions.get(input).run();        
      } else {
        System.out.println("Invalid command! Type 'help' for valid commands.");
      }
    }

  Bei jeder Ausführung der Schleife wird die Eingabe eines Commands erwartet. Das Programm überprüft, ob der eingegebene Command in der zuvor angelegten Hash-Map vorhanden ist. Andernfalls wird eine Fehlermeldung ausgegeben.

• quit():

    commandActions.put("quit()", () -> {
      while (true) {
        System.out.print("Do you really want to quit? (y|n) ");
        String ask = reader.nextLine();
        if (ask.equalsIgnoreCase("y")) {
          System.out.println("Exit with Exitcode 0");
          reader.close(); 
          System.exit(0);
        }
  
        if (ask.equalsIgnoreCase("n")) {
          System.out.println("Okay, you won't quit!");
          break;
        }
      }
    });

  Die Quit-Funktion verwendet eine While-Loop, um eine Bestätigung für das Beenden des Programms vom Benutzer zu erhalten. Abhängig von der Eingabe des Benutzers wird das Programm beendet oder fortgesetzt.

• help:

    commandActions.put("help", () -> {
      System.out.println("Valid Commands are: ");
      for (String key : commandActions.keySet()) {
        System.out.println("   * " + key);          
      }
    });

  Die help-Funktion gibt die verfügbaren Befehle aus. Dies wird dynamisch durch die Abfrage der in der Hash-Map gespeicherten Befehle ermöglicht.

• add:

    commandActions.put("add", () -> {
      Functions read = new Functions();
      read.addElement(bucket);  
    });

  Der Add-Command fügt Elemente zur Bucket-List hinzu. Die zugehörige Funktion befindet sich in der Klasse Functions.java.

    public void addElement(ArrayList<String> bucket) {
      System.out.println("\n\nTo quit, type 'break'.\n\n--- Add Items ---");
      Scanner reader = new Scanner(System.in);           
      while (true) { 
        System.out.print("Add: ");
        String input = reader.nextLine();
        if (input.equals("break")) {
          break;
        }
  
        bucket.add(input);                             
      }
      System.out.println("\n---- Done! ----\n");
    }

  Bei Aufruf dieser Funktion wird das String-Array übergeben. Der Benutzer wird aufgefordert, Elemente hinzuzufügen, bis er "break" eingibt.

• show:

    commandActions.put("show", () -> {
      System.out.println("\n\n---- Bucket List ----");
      for (String item : bucket) {
        System.out.println("   * " + item); 
      }
      System.out.println("\n---- Done! ----\n");
    });

  Die Show-Funktion gibt alle Elemente in der Bucket-Liste aus.

• delete:

    commandActions.put("delete", () -> {
      Functions delete = new Functions();
      delete.deleteElement(bucket);
    });

  Der delete-Befehl ermöglicht es dem Benutzer, spezifische Elemente aus der Bucket-Liste zu entfernen. Die entsprechende Funktion für das Löschen befindet sich ebenfalls in der Klasse Functions.java.

    public void deleteElement(ArrayList<String> bucket) {
      System.out.println("\n\nTo exit, type 'break'.\n\n--- Delete Items ---");
      Scanner reader = new Scanner(System.in);
      while (true) {
        System.out.println("Current items in the list:");
        for (int i = 0; i < bucket.size(); i++) {
          System.out.println("   " + i + ". " + bucket.get(i));
        }
        System.out.print("Enter the index of the item to delete (or 'break' to exit): ");
        String input = reader.nextLine();
        if (input.equals("break")) {
          break;
        }
        try {
          int index = Integer.parseInt(input);
          if (index >= 0 && index < bucket.size()) {
            bucket.remove(index);
            System.out.println("Item removed successfully!");
          } else {
            System.out.println("Invalid index. Please enter a valid index.");
          }
        } catch (NumberFormatException e) {
          System.out.println("Invalid input. Please enter a valid index.");
        }
      }
      System.out.println("\n---- Done! ----\n");
    }

  Diese Funktion bietet dem Benutzer die Möglichkeit, durch Eingabe des Indexes ein Element aus der Liste zu löschen. Bei Eingabe eines ungültigen Indexes oder des Befehls "break" wird die Funktion beendet.

Natürlich, ich werde die ReadMe für Sie ins Englische übersetzen:

English / Englisch

Installation

• Downloads:

  • JDK: Java Development Kit
  • Visual Studio Code: Visual Studio Code Download

• Installation:

  • Follow the instructions provided by the JDK installer.
  • In VS Code, under Extensions, download the Extension Pack for Java by Microsoft. You can do this by pressing ⇧ + ⌘ + X or Ctrl + Shift + X and then searching for it.

Code Description

• Importing Libraries:

    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.Map;
    import java.util.Scanner;

  Libraries:

  • ArrayList is essential for creating the listener.
  • HashMap & Map facilitate the creation of a hash map for efficient and rapid execution of commands.
  • Scanner is used for input monitoring.

• Array and Hash-Map:

    ArrayList<String> bucket = new ArrayList<>();
    Scanner reader = new Scanner(System.in);
  
    Map<String, Runnable> commandActions = new HashMap<>();

  The program uses arrays to store user inputs as strings. The bucket array object stores all user inputs, which can be displayed as tasks. The hash map allows for rapid assignment of values and associated actions, contrasting with linear search systems that can be inefficient with numerous objects.

• While Loop for Continuous Command Query:

    while (true) {
      System.out.print("Input: ");
      String input = reader.nextLine();
      if (commandActions.containsKey(input)) {  
        commandActions.get(input).run();        
      } else {
        System.out.println("Invalid command! Type 'help' for valid commands.");
      }
    }

  Every time the loop runs, it expects a command input. The program checks if the entered command exists in the previously created hash map. Otherwise, it displays an error message.

• quit():

    commandActions.put("quit()", () -> {
      while (true) {
        System.out.print("Do you really want to quit? (y|n) ");
        String ask = reader.nextLine();
        if (ask.equalsIgnoreCase("y")) {
          System.out.println("Exit with Exitcode 0");
          reader.close(); 
          System.exit(0);
        }
  
        if (ask.equalsIgnoreCase("n")) {
          System.out.println("Okay, you won't quit!");
          break;
        }
      }
    });

  The quit function employs a While-Loop to obtain user confirmation for program termination. Depending on the user's input, the program either terminates or continues.

• help:

    commandActions.put("help", () -> {
      System.out.println("Valid Commands are: ");
      for (String key : commandActions.keySet()) {
        System.out.println("   * " + key);          
      }
    });

  The help function lists available commands. This is dynamically done by querying the commands stored in the hash map.

• add:

    commandActions.put("add", () -> {
      Functions read = new Functions();
      read.addElement(bucket);  
    });

  The add command adds items to the bucket list. The associated function resides in the Functions.java class.

    public void addElement(ArrayList<String> bucket) {
      System.out.println("\n\nTo quit, type 'break'.\n\n--- Add Items ---");
      Scanner reader = new Scanner(System.in);           
      while (true) { 
        System.out.print("Add: ");
        String input = reader.nextLine();
        if (input.equals("break")) {
          break;
        }
  
        bucket.add(input);                             
      }
      System.out.println("\n---- Done! ----\n");
    }

  Upon function invocation, the string array is passed. Users are prompted to add items until they input "break".

• show:

    commandActions.put("show", () -> {
      System.out.println("\n\n---- Bucket List ----");
      for (String item : bucket) {
        System.out.println("   * " + item); 
      }
      System.out.println("\n---- Done! ----\n");
    });

  The show function displays all elements in the bucket list.

• delete:

    commandActions.put("delete", () -> {
      Functions delete = new Functions();
      delete.deleteElement(bucket);
    });

  The delete command allows users to remove specific items from the bucket list. The corresponding deletion function is also in the Functions.java class.

    public void deleteElement(ArrayList<String> bucket) {
      System.out.println("\n\nTo exit, type 'break'.\n\n--- Delete Items ---");
      Scanner reader = new Scanner(System.in);
      while (true) {
        System.out.println("Current items in the list:");
        for (int i = 0; i < bucket.size(); i++) {
          System.out.println("   " + i + ". " + bucket.get(i));
        }
        System.out.print("Enter the index of the item to delete (or 'break' to exit): ");
        String input = reader.nextLine();
        if (input.equals("break")) {
          break;
        }
        try {
          int index = Integer.parseInt(input);
          if (index >= 0 && index < bucket.size()) {
            bucket.remove(index);
            System.out.println("Item removed successfully!");
          } else {
            System.out.println("Invalid index. Please enter a valid index.");
          }
        } catch (NumberFormatException e) {
          System.out.println("Invalid input. Please enter a valid index.");
        }
      }
      System.out.println("\n---- Done! ----\n");
    }

  This function provides users with the ability to remove an item from the list by entering its index. If an invalid index or "break" command is entered, the function terminates.